fix(oas3): apply default encoding for form-urlencoded array properties#10819
Open
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Open
fix(oas3): apply default encoding for form-urlencoded array properties#10819maruthang wants to merge 1 commit intoswagger-api:masterfrom
maruthang wants to merge 1 commit intoswagger-api:masterfrom
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
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.
Description
Added an
afterLoadhook to the OAS3 plugin that wrapsfn.buildRequest. Before calling the originalbuildRequest, it inspects the spec and for anyapplication/x-www-form-urlencodedmedia type with array properties that lack explicit encoding, it adds the OAS3 default encoding (style: "form",explode: true). This ensures arrays serialize asnumbers=1&numbers=2&numbers=3instead ofnumbers=1,2,3.Motivation and Context
Fixes #7695
When encoding is omitted for
application/x-www-form-urlencodedrequest body array properties, Swagger UI used comma-separated values (numbers=1,2,3) instead of the OAS3 default exploded format (numbers=1&numbers=2&numbers=3). Per the OpenAPI 3.0 specification, the default serialization for form data isstyle: formwithexplode: true, which means each array element should be sent as a separate key-value pair.How Has This Been Tested?
test/unit/core/plugins/oas3/after-load.jscovering:Screenshots (if appropriate):
N/A - no UI changes.
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests