Add .indexInBrackets array serialization option for URL parameters #3516
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
TiagoMaiaL
force-pushed
the
feature/indexed-array-serialization
branch
from
95eb534
to
b085ad3
Compare
TiagoMaiaL
changed the title
TiagoMaiaL
changed the title
TiagoMaiaL
changed the title
jshier
requested changes
Nov 5, 2021
jshier
requested changes
Nov 5, 2021
TiagoMaiaL
force-pushed
the
feature/indexed-array-serialization
branch
from
fac8ac5
to
db327e3
Compare
jshier
pushed a commit
that referenced
this pull request
Jan 15, 2022
…3516) * Add the indexInBrackets option to URLEncoding * Add the indexInBrackets option to URLEncodedFormEncoder * Add .indexInBrackets tests for structs and classes * Address PR comments regarding .indexInBrackets serialization
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.
Issue Link 🔗
Goals ⚽
There is no real specification for how to encode URL parameters like arrays and dictionaries.
For
["foo": ["a", 1, true, ["bar": 2], ["qux": 3], ["quy": ["quz": 3]]]]default
.bracketsencode is:foo[]=a&foo[]=1&foo[]=1&foo[][bar]=2&foo[][qux]=3&foo[][quy][quz]=3.noBracketsencode is:foo=a&foo=1&foo=1&foo[bar]=2&foo[qux]=3&foo[quy][quz]=3jQuery >=1.4 and Node.js package query-string provide index style:
foo[0]=a&foo[1]=1&foo[2]=1&foo[3][bar]=2&foo[4][qux]=3&foo[5][quy][quz]=3Implementation Details 🚧
A new
ArrayEncodingenumeration case is added to bothURLEncodingandURLEncodedFormEncoder. The cases now are.bracketsand.noBracketsand.indexInBrackets. ThearrayEncodingoption passed to the initializer is used to control the array key serialization inURLEncodedFormEncoderandURLEncoding.Testing Details 🔍
New tests were added to the
ParameterEncoderTestsandParameterEncodingTestssuites. They follow the same naming convention but with an appendedWithIndexInBracketssuffix.Note:
This PR continues the work started at #3015.