Don't escape [ and ] in query param keys#2107
Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom Feb 11, 2019
Merged
Conversation
rails' default naming for arrays is name[]=...&name[]=... It doesn't recognize the escaped forms %5B + %5D but fails silently
Member
|
@BastiOfBerlin I don't think it's a breaking change but it's fine to include breaking changes in the upcoming 4.0.0 release. cc @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @nicokoenig (2018/09) @topce (2018/10) |
Member
|
I'll update the samples in a separate commit. |
Member
|
@BastiOfBerlin @wing328 I think we should revert this because square brackets are reserved characters, see https://stackoverflow.com/a/39294315 for a good explanation. |
wing328
pushed a commit
that referenced
this pull request
Feb 13, 2019
A-Joshi
pushed a commit
to ihsmarkitoss/openapi-generator
that referenced
this pull request
Feb 27, 2019
rails' default naming for arrays is name[]=...&name[]=... It doesn't recognize the escaped forms %5B + %5D but fails silently
A-Joshi
pushed a commit
to ihsmarkitoss/openapi-generator
that referenced
this pull request
Feb 27, 2019
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
3 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.
rails' default naming for arrays in query parameters is name[]=...&name[]=...
It doesn't recognize the escaped forms %5B + %5D but fails silently
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.sh,./bin/security/{LANG}-petstore.shand./bin/openapi3/security/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.master,. Default:3.4.x,4.0.xmaster.Description of the PR
Adapting the solution here to prevent HttpParameterCodec from encoding '[' and ']' in query param keys.
This is important for using Rails as a backend as the square brackets are added to the parameter names as per default.
I suppose this change doesn't interfere with most people's APIs as square brackets are not common suffixes other to arrays. Encoding them on the other hand is not necessary for URIs and users could still do this if required for their specific project.
However, if this still considered to be a breaking change, I suppose introducing an additional parameter such as 'rails-compat-query-array-params'.