chore: reuse parameters to make the openapi file smaller #2382
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
danielbdias
approved these changes
Apr 13, 2023
| - $ref: "./parameters.yaml#/components/parameters/take" | ||
| - $ref: "./parameters.yaml#/components/parameters/skip" | ||
| - $ref: "./parameters.yaml#/components/parameters/query" | ||
| - $ref: "./parameters.yaml#/components/parameters/runnableResourceSortBy" |
There was a problem hiding this comment.
Question: is there a way to "override" ref attributes? I believe that we have many similar sortBy fields with only the enum with different values.
There was a problem hiding this comment.
Unfortunately, no :(
api/openapi.yaml
Outdated
| - $ref: "./parameters.yaml#/components/parameters/take" | ||
| - $ref: "./parameters.yaml#/components/parameters/skip" | ||
| - $ref: "./parameters.yaml#/components/parameters/query" | ||
| - $ref: "./parameters.yaml#/components/parameters/sortBy" |
There was a problem hiding this comment.
Here it should be a runnableResourceSortBy, right?
mathnogueira
force-pushed
the
chore/openapi-parameters
branch
from
b7a8dcd to
b46ecbb
Compare
mathnogueira
force-pushed
the
chore/openapi-parameters
branch
from
b46ecbb to
8bea17d
Compare
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.
This PR reduces the size of the openapi file by reusing the common parameters when defining endpoints
Checklist