Add docstring for HTTPClient header validation contract#706
Open
Alan4506 wants to merge 2 commits into
Open
Conversation
jonathan343
reviewed
Jun 2, 2026
| Header field names and values are not validated before reaching this | ||
| layer. Implementations of ``HTTPClient`` are responsible for this | ||
| validation: if a request's fields contain characters prohibited by | ||
| the HTTP specifications (such as CR or LF), the request MUST be |
Contributor
There was a problem hiding this comment.
the HTTP specifications
Why not call out RFC 9110 directly? If someone want's to create an implement of HTTPClient, we should make it easy to find which spec we're talking about
Alan4506
force-pushed
the
http-client-note-clean
branch
from
9c1c3d5 to
4ba367e
Compare
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
2 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.
Description of changes:
Add docstring for
HTTPClientto specify: if a request's header fields contain characters prohibited by the HTTP specifications (e.g. CR, LF), it is implementer's responsibility that they must reject the request. The default clients (AWSCRTHTTPClient,AIOHTTPClient) already satisfy this via their underlying libraries.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.