204 Refactor: Split Open API documentation into multiple files #375
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
horatiorosa
force-pushed
the
Issue/204-split-openapi-docs-into-diff-files
branch
from
d6533fc to
3cd14fd
Compare
TangoYankee
reviewed
Sep 11, 2024
TangoYankee
requested changes
Sep 11, 2024
- Used redocly `split` to create a multi-filer structure by extracting parts into standalone separate `yaml` files
- component folder containing:
- parameters folder: contains all parameters
- responses folder: contains all responses
- schema folder: contains all schemas
- paths folder: contains all paths
- params in the path are indicated by curly brackets`{ }` and backslashes ` / ` are replaced by underscores ` _ `
- `boroughs_{boroughId}_community-districts.yaml`
s forgot to commit this
horatiorosa
force-pushed
the
Issue/204-split-openapi-docs-into-diff-files
branch
from
3cd14fd to
af441b3
Compare
TangoYankee
approved these changes
Sep 11, 2024
horatiorosa
deleted the
Issue/204-split-openapi-docs-into-diff-files
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Used redocly
splitto create a multi-filer structure by extracting parts into standalone separateyamlfiles{ }/are replaced by underscores_boroughs_{boroughId}_community-districts.yaml