Move parameters schema keywords location #108
Merged
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
marclave
reviewed
Mar 24, 2024
| return { | ||
| // @ts-ignore | ||
| ...rest, |
There was a problem hiding this comment.
do we need to keep this spread of rest at the root of the return and not in schema?
i'll be pulling and testing out tonight but wanted to give a review before that and ask ahead :)
There was a problem hiding this comment.
@marclave
Had a thought of it and I think it makes more sense to be under schema.
Most JSON schema keywords goes under schema except for description, required, examples. So there's lesser keywords to define
Also when we choose to define some keywords and send others to spread, it makes more sense to me to define generic keywords explicitly and send type-specific keywords like minLength, which belongs to schema, to the rest
| @@ -27,17 +27,30 @@ it('returns a valid Swagger/OpenAPI json config for many routes', async () => { | |||
| ) | |||
| .post( | |||
| '/json/:id', | |||
| ({ body, params: { id }, query: { name } }) => ({ | |||
| ({ body, params: { id }, query: { name, email, birthday } }) => ({ | |||
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.
descriptionandexamplesas parameter keywords, while move others to schema keywords. Based on: