Skip to content

Commit a8d396e

Browse files
authored
docs: clarify HTTP/1 header casing directions (envoyproxy#44939)
Commit Message: docs: clarify HTTP/1 header casing directions Additional Description: Fix the header casing guide to describe the correct directions for HTTP/1 header_key_format configuration. For more details, please see envoyproxy#44924. HttpConnectionManager http_protocol_options controls formatting for upstream request headers, while cluster HttpProtocolOptions controls formatting for downstream response headers. Also update the API comments to describe header_key_format as applying to headers encoded by the HTTP/1 codec rather than only response headers. Fixes envoyproxy#44924 Signed-off-by: SunBK201 <sunbk201gm@gmail.com>
1 parent 69b4fee commit a8d396e

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

api/envoy/config/core/v3/protocol.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -445,8 +445,8 @@ message Http1ProtocolOptions {
445445
// This is a no-op if ``accept_http_10`` is not true.
446446
string default_host_for_http_10 = 3;
447447

448-
// Describes how the keys for response headers should be formatted. By default, all header keys
449-
// are lower cased.
448+
// Describes how the keys for headers encoded by the HTTP/1 codec should be formatted. By
449+
// default, all header keys are lower cased.
450450
HeaderKeyFormat header_key_format = 4;
451451

452452
// Enables trailers for HTTP/1. By default the HTTP/1 codec drops proxied trailers.

docs/root/configuration/http/http_conn_man/header_casing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ To support these use cases, Envoy allows :ref:`configuring a formatting scheme f
1111
<envoy_v3_api_field_config.core.v3.Http1ProtocolOptions.header_key_format>`, which will have Envoy
1212
transform the header keys during serialization.
1313

14-
To configure this formatting on response headers, specify the format in the
14+
To configure this formatting on upstream request headers, specify the format in the
1515
:ref:`http_protocol_options
1616
<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.http_protocol_options>`.
17-
To configure this for upstream request headers, specify the formatting in
17+
To configure this for downstream response headers, specify the formatting in
1818
:ref:`http_protocol_options <envoy_v3_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>` in
1919
the cluster's
2020
:ref:`extension_protocol_options<envoy_v3_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`.

0 commit comments

Comments
 (0)