Fix querySerializer example #1517
Merged
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.
Changes
The example function for the
querySerializer
doesn't actually do what it says it does.The comment next to the return statement suggests the output would be
?tags[]=food&tags[]=california&tags[]=healthy
, however the output of the current snippet is actually:tags[]=food,california,healthy
.Furthermore, the snippet also does not place any
&
characters between query parameters.This PR fixes that, so that the output is actually
?tags[]=food&tags[]=california&tags[]=healthy
(strictly, the output is actuallytags[]=food&tags[]=california&tags[]=healthy
but I just assumed the?
is to demonstrate how it would look like in an URL)How to Review
Try the new snippet.
Checklist
docs/
updated (if necessary)pnpm run update:examples
run (only applicable for openapi-typescript)