URL encode parameters for OpenApiSpec 3 #1331
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.
URL encode parameters for OpenApiSpec 3
Description
Fixes this issue in swagger-ui swagger-api/swagger-ui#4025
Motivation and Context
I guess it was disabled by accident in #1181 which was about allowing to skip url encode for query params if
Paramter.allowReserved
is set to true. But specification says clearly:Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.
. So it should be applied only to query params and path parameters should use encoding all the timeHow Has This Been Tested?
I'm not familiar with your testing strategy, but I've recompiled your library and checked that it works correctly using swagger-ui:
Before:


After:
Types of changes
package.json
)Checklist: