explode defaults to true for query parameters
#7148
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
ogugu9
requested review from
bterlson,
markcowl,
allenjzhang,
timotheeguerin,
witemple-msft,
chrisradek and
AlitzelMendez
as code owners
microsoft-github-policy-service
bot
added
the
emitter:openapi3
ogugu9
force-pushed
the
query-explode-default
branch
from
0e10183 to
5c43899
Compare
|
@microsoft-github-policy-service agree |
packages/openapi3/src/openapi.ts
Outdated
| @@ -1544,7 +1544,7 @@ function createOAPIEmitter( | |||
|
|
|||
| if (httpProperty.options.explode !== true) { | |||
| // For query parameters(style: form) the default is explode: true https://spec.openapis.org/oas/v3.0.2#fixed-fields-9 | |||
| attributes.explode = false; | |||
| attributes.explode = true; | |||
There was a problem hiding this comment.
Hi @ogugu9 thanks for the contribution,
can you clarify a bit more why this is needed. That pr you linked exactly fixed this issue where the explode value in openapi3 didn't match what we had in the typespec.
The value of explode should always be seens as the same it just happens that we have different defaults so we need to reflect that.
Can you show an example of your issue in the playground https://typespec.io/playground
ogugu9
requested review from
joheredi,
timovv,
qiaozha,
MaryGao and
xirzec
as code owners
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.
From #4167, the default value of
explodein the query parameter has becomefalse.However, according to the OpenAPI v3 specification, the default value of
explodein the query parameter istrue.Actually, the code comment says that
For query parameters(style: form) the default is explode: trueas opposed to the implementation.typespec/packages/openapi3/src/openapi.ts
Lines 1545 to 1548 in f5fbe0a
Therefore, I changed the default value of
explodetotruein this PR.