Fix encoding of query params when openapi is v3 #671
Conversation
This file contains 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
|
@romanblanco Checkout this PR, we had a discussion here |
BrianHawley
reviewed
May 24, 2024
| @@ -173,6 +173,8 @@ def build_query_string_part(param, value, swagger_doc) | |||
| end | |||
| return "#{escaped_name}=" + value.to_a.flatten.map{|v| CGI.escape(v.to_s) }.join(separator) | |||
| end | |||
| when :string | |||
| return "#{escaped_name}=#{CGI.escape(value.to_s)}" | |||
| else | |||
| return "#{name}=#{value}" | |||
There was a problem hiding this comment.
Why not just change this line instead? That way you'll never be adding unescaped values.
|
#725 fixes the same bug but does the change I suggested instead. It should be used instead. |
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.
Problem
URL encoding is not processed correctly when I define a string query parameter as
{ schema: { type: :string } }in OpenAPI v3. This issue occurs even if I define the schema as simply{ type: :string }when I have multiple test cases. This is because{ type: :string }is automatically converted to{ schema: { type: :string } }after one test case finishes and before the next one starts.Solution
Update
build_query_string_partand handle query parameter defined as{ schema: { type: :string } }This concerns this parts of the OpenAPI Specification:
The changes I made are compatible with:
Related Issues
#606 (comment)
Checklist
I didn't update readme because this is bug fix
Steps to Test or Reproduce
Add a query parameter with
{ schema: { type: :string } }that is in datetime format. Before this PR, the '+' symbol in the parameters would be replaced with a whitespace after encoding.