add notes documentation for headers #408
Merged
Conversation
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
graebm
approved these changes
Dec 16, 2022
include/aws/http/request_response.h
Outdated
| * `:scheme` is default to be "https". If a different scheme wants to be used, create the HTTP/2 message directly | ||
| * Note: | ||
| * - if `host` exist, it will be removed and `:authority` will be added using the information. | ||
| * - `:scheme` is always default to be "https". If a different scheme wants to be used, |
Contributor
There was a problem hiding this comment.
nit: ":scheme always defaults to "https". To use a different scheme create the HTTP/2 message directly"
include/aws/http/request_response.h
Outdated
| * Tip for language bindings: Do not bind the `options` struct. Use something more natural for your language, | ||
| * such as Builder Pattern in Java, or Python's ability to take many optional arguments by name. | ||
| * | ||
| * Note: The header of the request will be sent as it is. Unless HTTP/1 message used on HTTP/2 connection, then |
Contributor
There was a problem hiding this comment.
nit: this is a bit confusing. maybe explicitly state that for http1 messages on http1 connection and http2 on http2 con headers are sent as is, but for corner case of http1 message on http2 this corner case applies.
Might also be worth mentioning what happens with reverse http2 message on http1 conn
DmitriyMusatkin
approved these changes
Dec 20, 2022
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.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.