Skip to content

Commit 4e82c1e

Browse files
authored
add notes documentation for headers (#408)
1 parent f19e8e2 commit 4e82c1e

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

include/aws/http/request_response.h

+11-2
Original file line numberDiff line numberDiff line change
@@ -694,8 +694,9 @@ struct aws_http_message *aws_http2_message_new_response(struct aws_allocator *al
694694
* Create an HTTP/2 message from HTTP/1.1 message.
695695
* pseudo headers will be created from the context and added to the headers of new message.
696696
* Normal headers will be copied to the headers of new message.
697-
* Note: if `host` exist, it will stay and `:authority` will be added using the information.
698-
* `:scheme` is default to be "https". If a different scheme wants to be used, create the HTTP/2 message directly
697+
* Note:
698+
* - if `host` exist, it will be removed and `:authority` will be added using the information.
699+
* - `:scheme` always defaults to "https". To use a different scheme create the HTTP/2 message directly
699700
*/
700701
AWS_HTTP_API
701702
struct aws_http_message *aws_http2_message_new_from_http1(
@@ -939,6 +940,14 @@ int aws_http_message_erase_header(struct aws_http_message *message, size_t index
939940
*
940941
* Tip for language bindings: Do not bind the `options` struct. Use something more natural for your language,
941942
* such as Builder Pattern in Java, or Python's ability to take many optional arguments by name.
943+
*
944+
* Note: The header of the request will be sent as it is when the message to send protocol matches the protocol of the
945+
* connection.
946+
* - No `user-agent` will be added.
947+
* - No security check will be enforced. eg: `referer` header privacy should be enforced by the user-agent who adds the
948+
* header
949+
* - When HTTP/1 message sent on HTTP/2 connection, `aws_http2_message_new_from_http1` will be applied under the hood.
950+
* - When HTTP/2 message sent on HTTP/1 connection, no change will be made.
942951
*/
943952
AWS_HTTP_API
944953
struct aws_http_stream *aws_http_connection_make_request(

0 commit comments

Comments
 (0)