docs: clarify params query canonicalization behavior#12202
Open
mitre88 wants to merge 1 commit intoaio-libs:masterfrom
Open
docs: clarify params query canonicalization behavior#12202mitre88 wants to merge 1 commit intoaio-libs:masterfrom
mitre88 wants to merge 1 commit intoaio-libs:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12202 +/- ##
==========================================
- Coverage 98.88% 98.88% -0.01%
==========================================
Files 130 130
Lines 45388 45388
Branches 2417 2417
==========================================
- Hits 44883 44882 -1
Misses 347 347
- Partials 158 159 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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
1 participant
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.
What do these changes do?
This updates the client quickstart docs around
paramswith string values.The previous wording suggested that string params are "not encoded by library". The updated text clarifies that using
paramsdoes not disable URL canonicalization/requoting, and keeps the existing+example.I also expanded the warning for
encoded=Trueto make it explicit thatparamsoverrides it, and that preserving exact query-string bytes requires building the full URL (including query) withoutparams.Are there changes in behavior for the user?
No runtime behavior changes. This is a documentation-only clarification.
Is it a substantial burden for the maintainers to support this?
No. This is a small wording change in one doc section.
Related issue number
Fixes #3689
Checklist
CONTRIBUTORS.txtCHANGES/folder