feat: Explode query string #44
Open
Conversation
This file contains hidden or 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
OpenAPI 3 accepts parameters whose schema is an object When specified, these parameters can be `in: query` Such parameters can specify a style used to express them in the URL The default style for `in: query` parameters is `form` `form`-style parameters are expressed with a parameter-per-terminal value in the query object This change extends the existing query params encoder. It can now express nested objects and arrays in addition to scalar values
duncanbeevers
force-pushed
the
feat/form-encode-query-params
branch
from
daa6639 to
9647277
Compare
NicoGrapsasWK
approved these changes
Jan 25, 2023
|
👋 is this library still being maintained ? |
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
🐸 Problem to Solve
OpenAPI 3 accepts parameters whose schema is an object.
When passing data to a fetch function, nested query values get stringified as
[object Object].👑 Solution
This change extends the existing query params encoder.
It can now express nested objects and arrays in addition to scalar values.
It uses the
form-style query parameter encoding which is the default style forqueryparameters.🔧 Changes (and non-Changes)
I included a bunch of examples in the tests for the
src/explodeQueryFormStyle.tsutility.I also added validation of url-encoding behavior in the fetcher tests.