diff --git a/api/contrib/envoy/extensions/vcl/v3alpha/vcl_socket_interface.proto b/api/contrib/envoy/extensions/vcl/v3alpha/vcl_socket_interface.proto index d2c6a9f1d8a3f..fc9d2b88535a3 100644 --- a/api/contrib/envoy/extensions/vcl/v3alpha/vcl_socket_interface.proto +++ b/api/contrib/envoy/extensions/vcl/v3alpha/vcl_socket_interface.proto @@ -11,7 +11,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/vcl option (udpa.annotations.file_status).work_in_progress = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Vcl Socket Interface configuration] +// [#protodoc-title: VCL socket interface configuration] // VCL :ref:`configuration overview `. // [#extension: envoy.bootstrap.vcl] diff --git a/api/envoy/admin/v3/server_info.proto b/api/envoy/admin/v3/server_info.proto index 8516429904874..b623f7feae639 100644 --- a/api/envoy/admin/v3/server_info.proto +++ b/api/envoy/admin/v3/server_info.proto @@ -15,7 +15,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/admin/v3;adminv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Server State] +// [#protodoc-title: Server state] // Proto representation of the value returned by /server_info, containing // server version/server status information. diff --git a/api/envoy/config/common/key_value/v3/config.proto b/api/envoy/config/common/key_value/v3/config.proto index 566461fb084c8..a20e6ead14c94 100644 --- a/api/envoy/config/common/key_value/v3/config.proto +++ b/api/envoy/config/common/key_value/v3/config.proto @@ -15,7 +15,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/common/key_value/v3;key_valuev3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Key Value Store storage plugin] +// [#protodoc-title: Key/value store storage plugin] // This shared configuration for Envoy key value stores. message KeyValueStoreConfig { diff --git a/api/envoy/config/common/mutation_rules/v3/mutation_rules.proto b/api/envoy/config/common/mutation_rules/v3/mutation_rules.proto index 3149c035def06..e728925d0f3b3 100644 --- a/api/envoy/config/common/mutation_rules/v3/mutation_rules.proto +++ b/api/envoy/config/common/mutation_rules/v3/mutation_rules.proto @@ -14,7 +14,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/common/mutation_rules/v3;mutation_rulesv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Header Mutation Rules] +// [#protodoc-title: Header mutation rules] // The HeaderMutationRules structure specifies what headers may be // manipulated by a processing filter. This set of rules makes it diff --git a/api/envoy/config/core/v3/backoff.proto b/api/envoy/config/core/v3/backoff.proto index 1899d1abf1147..435b36190e0eb 100644 --- a/api/envoy/config/core/v3/backoff.proto +++ b/api/envoy/config/core/v3/backoff.proto @@ -14,7 +14,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/core/v3;corev3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Backoff Strategy] +// [#protodoc-title: Backoff strategy] // Configuration defining a jittered exponential back off strategy. message BackoffStrategy { diff --git a/api/envoy/config/core/v3/http_uri.proto b/api/envoy/config/core/v3/http_uri.proto index 917f4891847e0..93b63093e3776 100644 --- a/api/envoy/config/core/v3/http_uri.proto +++ b/api/envoy/config/core/v3/http_uri.proto @@ -14,7 +14,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/core/v3;corev3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: HTTP Service URI ] +// [#protodoc-title: HTTP service URI ] // Envoy external URI descriptor message HttpUri { diff --git a/api/envoy/config/core/v3/proxy_protocol.proto b/api/envoy/config/core/v3/proxy_protocol.proto index 9cfdbe5f66cda..c276ce4d58ed1 100644 --- a/api/envoy/config/core/v3/proxy_protocol.proto +++ b/api/envoy/config/core/v3/proxy_protocol.proto @@ -10,7 +10,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/core/v3;corev3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Proxy Protocol] +// [#protodoc-title: Proxy protocol] message ProxyProtocolConfig { enum Version { diff --git a/api/envoy/config/core/v3/socket_option.proto b/api/envoy/config/core/v3/socket_option.proto index d4706eb4a5729..9e8f2c0ee73ab 100644 --- a/api/envoy/config/core/v3/socket_option.proto +++ b/api/envoy/config/core/v3/socket_option.proto @@ -12,7 +12,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/core/v3;corev3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Socket Option ] +// [#protodoc-title: Socket option] // Generic socket option message. This would be used to set socket options that // might not exist in upstream kernels or precompiled Envoy binaries. diff --git a/api/envoy/config/tap/v3/common.proto b/api/envoy/config/tap/v3/common.proto index 6afba487e9dcb..1884bd57d3d17 100644 --- a/api/envoy/config/tap/v3/common.proto +++ b/api/envoy/config/tap/v3/common.proto @@ -21,7 +21,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/tap/v3;tapv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Common tap configuration] +// [#protodoc-title: Tap common configuration] // Tap configuration. message TapConfig { diff --git a/api/envoy/extensions/common/matching/v3/extension_matcher.proto b/api/envoy/extensions/common/matching/v3/extension_matcher.proto index 010adc52846f6..53dcf9d4b7030 100644 --- a/api/envoy/extensions/common/matching/v3/extension_matcher.proto +++ b/api/envoy/extensions/common/matching/v3/extension_matcher.proto @@ -18,7 +18,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/common/matching/v3;matchingv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Extension Matcher] +// [#protodoc-title: Extension matcher] // Wrapper around an existing extension that provides an associated matcher. This allows // decorating an existing extension with a matcher, which can be used to match against diff --git a/api/envoy/extensions/filters/common/matcher/action/v3/skip_action.proto b/api/envoy/extensions/filters/common/matcher/action/v3/skip_action.proto index 95346a2ae15f1..714930a8d2d38 100644 --- a/api/envoy/extensions/filters/common/matcher/action/v3/skip_action.proto +++ b/api/envoy/extensions/filters/common/matcher/action/v3/skip_action.proto @@ -10,7 +10,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/common/matcher/action/v3;actionv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Common Match Actions] +// [#protodoc-title: Common match actions] // Configuration for the SkipFilter match action. When matching results in this action, the // associated filter will be ignored for all filter callbacks (e.g. ``encodeHeaders``, ``encodeData``, diff --git a/api/envoy/extensions/key_value/file_based/v3/config.proto b/api/envoy/extensions/key_value/file_based/v3/config.proto index a07de903626e3..3044709bae54d 100644 --- a/api/envoy/extensions/key_value/file_based/v3/config.proto +++ b/api/envoy/extensions/key_value/file_based/v3/config.proto @@ -16,7 +16,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/key_value/file_based/v3;file_basedv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: File Based Key Value Store storage plugin] +// [#protodoc-title: Key/value file-based store storage plugin] // [#extension: envoy.key_value.file_based] // This is configuration to flush a key value store out to disk. diff --git a/api/envoy/extensions/matching/common_inputs/environment_variable/v3/input.proto b/api/envoy/extensions/matching/common_inputs/environment_variable/v3/input.proto index 9bb8e5e7bdc44..67122861c7fbe 100644 --- a/api/envoy/extensions/matching/common_inputs/environment_variable/v3/input.proto +++ b/api/envoy/extensions/matching/common_inputs/environment_variable/v3/input.proto @@ -11,7 +11,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/matching/common_inputs/environment_variable/v3;environment_variablev3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Environment Variable Input] +// [#protodoc-title: Environment variable input] // [#extension: envoy.matching.common_inputs.environment_variable] // Reads an environment variable to provide an input for matching. diff --git a/api/envoy/extensions/matching/common_inputs/network/v3/network_inputs.proto b/api/envoy/extensions/matching/common_inputs/network/v3/network_inputs.proto index 8a00a3351e572..467771dff6a19 100644 --- a/api/envoy/extensions/matching/common_inputs/network/v3/network_inputs.proto +++ b/api/envoy/extensions/matching/common_inputs/network/v3/network_inputs.proto @@ -10,7 +10,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/matching/common_inputs/network/v3;networkv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Common Network Matching Inputs] +// [#protodoc-title: Common network matching inputs] // Specifies that matching should be performed by the destination IP address. // [#extension: envoy.matching.inputs.destination_ip] diff --git a/api/envoy/extensions/matching/common_inputs/ssl/v3/ssl_inputs.proto b/api/envoy/extensions/matching/common_inputs/ssl/v3/ssl_inputs.proto index a1bf56a2aed05..aee03187c230b 100644 --- a/api/envoy/extensions/matching/common_inputs/ssl/v3/ssl_inputs.proto +++ b/api/envoy/extensions/matching/common_inputs/ssl/v3/ssl_inputs.proto @@ -10,7 +10,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/matching/common_inputs/ssl/v3;sslv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Common SSL Matching Inputs] +// [#protodoc-title: Common SSL matching inputs] // List of comma-delimited URIs in the SAN field of the peer certificate for a downstream. // [#extension: envoy.matching.inputs.uri_san] diff --git a/api/envoy/extensions/matching/input_matchers/consistent_hashing/v3/consistent_hashing.proto b/api/envoy/extensions/matching/input_matchers/consistent_hashing/v3/consistent_hashing.proto index 77d62ab5a8e60..de6893483c76f 100644 --- a/api/envoy/extensions/matching/input_matchers/consistent_hashing/v3/consistent_hashing.proto +++ b/api/envoy/extensions/matching/input_matchers/consistent_hashing/v3/consistent_hashing.proto @@ -11,7 +11,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/matching/input_matchers/consistent_hashing/v3;consistent_hashingv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Consistent Hashing Matcher] +// [#protodoc-title: Consistent hashing matcher] // [#extension: envoy.matching.matchers.consistent_hashing] // The consistent hashing matchers computes a consistent hash from the input and matches if the resulting hash diff --git a/api/envoy/extensions/network/socket_interface/v3/default_socket_interface.proto b/api/envoy/extensions/network/socket_interface/v3/default_socket_interface.proto index f5a3294456a14..ae2693871f725 100644 --- a/api/envoy/extensions/network/socket_interface/v3/default_socket_interface.proto +++ b/api/envoy/extensions/network/socket_interface/v3/default_socket_interface.proto @@ -10,7 +10,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/network/socket_interface/v3;socket_interfacev3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Default Socket Interface configuration] +// [#protodoc-title: Default socket interface configuration] // Configuration for default socket interface that relies on OS dependent syscall to create // sockets. diff --git a/api/envoy/extensions/udp_packet_writer/v3/udp_gso_batch_writer_factory.proto b/api/envoy/extensions/udp_packet_writer/v3/udp_gso_batch_writer_factory.proto index aad5c78ec0747..e0fc23a8a1d5b 100644 --- a/api/envoy/extensions/udp_packet_writer/v3/udp_gso_batch_writer_factory.proto +++ b/api/envoy/extensions/udp_packet_writer/v3/udp_gso_batch_writer_factory.proto @@ -10,7 +10,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/udp_packet_writer/v3;udp_packet_writerv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: UDP packet writer config] +// [#protodoc-title: UDP GSO batch packet writer config] // [#extension: envoy.udp_packet_writer.gso] // Configuration for the UDP GSO batch packet writer factory. diff --git a/api/envoy/service/accesslog/v3/als.proto b/api/envoy/service/accesslog/v3/als.proto index 1497eb35388a2..8d0da71bd53a8 100644 --- a/api/envoy/service/accesslog/v3/als.proto +++ b/api/envoy/service/accesslog/v3/als.proto @@ -16,7 +16,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/access option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: gRPC Access Log Service (ALS)] +// [#protodoc-title: gRPC access log service (ALS)] // Service for streaming access logs from Envoy to an access log server. service AccessLogService { diff --git a/api/envoy/service/auth/v3/attribute_context.proto b/api/envoy/service/auth/v3/attribute_context.proto index b767bdfb680e7..ab901311ee511 100644 --- a/api/envoy/service/auth/v3/attribute_context.proto +++ b/api/envoy/service/auth/v3/attribute_context.proto @@ -16,7 +16,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/auth/v3;authv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Attribute Context ] +// [#protodoc-title: Attribute context] // See :ref:`network filter configuration overview ` // and :ref:`HTTP filter configuration overview `. diff --git a/api/envoy/service/auth/v3/external_auth.proto b/api/envoy/service/auth/v3/external_auth.proto index 2e2f6496a100e..5cedc6b643934 100644 --- a/api/envoy/service/auth/v3/external_auth.proto +++ b/api/envoy/service/auth/v3/external_auth.proto @@ -20,7 +20,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/auth/v option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Authorization Service ] +// [#protodoc-title: Authorization service] // The authorization service request messages used by external authorization :ref:`network filter // ` and :ref:`HTTP filter `. diff --git a/api/envoy/service/ext_proc/v3/external_processor.proto b/api/envoy/service/ext_proc/v3/external_processor.proto index c073046e01eab..b784df6dbb5cd 100644 --- a/api/envoy/service/ext_proc/v3/external_processor.proto +++ b/api/envoy/service/ext_proc/v3/external_processor.proto @@ -21,7 +21,7 @@ option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; option (xds.annotations.v3.file_status).work_in_progress = true; -// [#protodoc-title: External Processing Service] +// [#protodoc-title: External processing service] // A service that can access and modify HTTP requests and responses // as part of a filter chain. diff --git a/api/envoy/service/extension/v3/config_discovery.proto b/api/envoy/service/extension/v3/config_discovery.proto index 3a0337a3140ea..f04986079d600 100644 --- a/api/envoy/service/extension/v3/config_discovery.proto +++ b/api/envoy/service/extension/v3/config_discovery.proto @@ -16,7 +16,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/extens option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Extension Config Discovery Service (ECDS)] +// [#protodoc-title: Extension config discovery service (ECDS)] // Return extension configurations. service ExtensionConfigDiscoveryService { diff --git a/api/envoy/service/health/v3/hds.proto b/api/envoy/service/health/v3/hds.proto index 025e822ebf1b1..06130ec48e6df 100644 --- a/api/envoy/service/health/v3/hds.proto +++ b/api/envoy/service/health/v3/hds.proto @@ -21,7 +21,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/health option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Health Discovery Service (HDS)] +// [#protodoc-title: Health discovery service (HDS)] // HDS is Health Discovery Service. It compliments Envoy’s health checking // service by designating this Envoy to be a healthchecker for a subset of hosts diff --git a/api/envoy/service/load_stats/v3/lrs.proto b/api/envoy/service/load_stats/v3/lrs.proto index 4a163b737ed70..d28cfc3677e57 100644 --- a/api/envoy/service/load_stats/v3/lrs.proto +++ b/api/envoy/service/load_stats/v3/lrs.proto @@ -17,7 +17,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/load_s option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Load Reporting service (LRS)] +// [#protodoc-title: Load reporting service (LRS)] // Load Reporting Service is an Envoy API to emit load reports. Envoy will initiate a bi-directional // stream with a management server. Upon connecting, the management server can send a diff --git a/api/envoy/service/ratelimit/v3/rls.proto b/api/envoy/service/ratelimit/v3/rls.proto index 5f840f44f9d24..28dd52b9b0196 100644 --- a/api/envoy/service/ratelimit/v3/rls.proto +++ b/api/envoy/service/ratelimit/v3/rls.proto @@ -20,7 +20,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/rateli option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Rate Limit Service (RLS)] +// [#protodoc-title: Rate limit service (RLS)] service RateLimitService { // Determine whether rate limiting should take place. diff --git a/api/envoy/service/runtime/v3/rtds.proto b/api/envoy/service/runtime/v3/rtds.proto index 8cffbe583dd14..cbae742b261de 100644 --- a/api/envoy/service/runtime/v3/rtds.proto +++ b/api/envoy/service/runtime/v3/rtds.proto @@ -19,7 +19,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/runtim option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Runtime Discovery Service (RTDS)] +// [#protodoc-title: Runtime discovery service (RTDS)] // RTDS :ref:`configuration overview ` // Discovery service for Runtime resources. diff --git a/api/envoy/service/status/v3/csds.proto b/api/envoy/service/status/v3/csds.proto index 67e89a893fe95..70ab587fa739e 100644 --- a/api/envoy/service/status/v3/csds.proto +++ b/api/envoy/service/status/v3/csds.proto @@ -21,7 +21,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/status option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Client Status Discovery Service (CSDS)] +// [#protodoc-title: Client status discovery service (CSDS)] // CSDS is Client Status Discovery Service. It can be used to get the status of // an xDS-compliant client from the management server's point of view. It can diff --git a/api/envoy/service/tap/v3/tap.proto b/api/envoy/service/tap/v3/tap.proto index f97fe451218ab..0ac0de67be4b1 100644 --- a/api/envoy/service/tap/v3/tap.proto +++ b/api/envoy/service/tap/v3/tap.proto @@ -16,7 +16,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/tap/v3 option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Tap Sink Service] +// [#protodoc-title: Tap sink service] // [#not-implemented-hide:] A tap service to receive incoming taps. Envoy will call // StreamTaps to deliver captured taps to the server diff --git a/api/envoy/type/http/v3/cookie.proto b/api/envoy/type/http/v3/cookie.proto index fba35eb86a3cb..4fe0c2f69df60 100644 --- a/api/envoy/type/http/v3/cookie.proto +++ b/api/envoy/type/http/v3/cookie.proto @@ -13,7 +13,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/type/http/v3;httpv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Http cookie API] +// [#protodoc-title: HTTP cookie API] // Cookie defines an API for obtaining or generating HTTP cookie. message Cookie { diff --git a/api/envoy/type/matcher/v3/http_inputs.proto b/api/envoy/type/matcher/v3/http_inputs.proto index 68ce45030ec74..27e29bf1333c3 100644 --- a/api/envoy/type/matcher/v3/http_inputs.proto +++ b/api/envoy/type/matcher/v3/http_inputs.proto @@ -11,7 +11,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/type/matcher/v3;matcherv3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Common HTTP Inputs] +// [#protodoc-title: Common HTTP inputs] // Match input indicates that matching should be done on a specific request header. // The resulting input string will be all headers for the given key joined by a comma, diff --git a/api/envoy/type/v3/semantic_version.proto b/api/envoy/type/v3/semantic_version.proto index e1567612ab7d4..e032b4cd22d6f 100644 --- a/api/envoy/type/v3/semantic_version.proto +++ b/api/envoy/type/v3/semantic_version.proto @@ -11,7 +11,7 @@ option java_multiple_files = true; option go_package = "github.com/envoyproxy/go-control-plane/envoy/type/v3;typev3"; option (udpa.annotations.file_status).package_version_status = ACTIVE; -// [#protodoc-title: Semantic Version] +// [#protodoc-title: Semantic version] // Envoy uses SemVer (https://semver.org/). Major/minor versions indicate // expected behaviors and APIs, the patch version field is used only diff --git a/docs/root/api-v3/api.rst b/docs/root/api-v3/api.rst index 7dcb72a8ec829..061c653cf453d 100644 --- a/docs/root/api-v3/api.rst +++ b/docs/root/api-v3/api.rst @@ -16,4 +16,5 @@ v3 API reference data/data service/service common_messages/common_messages + common_messages/common_messages_xds types/types diff --git a/docs/root/api-v3/bootstrap/bootstrap.rst b/docs/root/api-v3/bootstrap/bootstrap.rst index 8082028c72817..4c454d0180976 100644 --- a/docs/root/api-v3/bootstrap/bootstrap.rst +++ b/docs/root/api-v3/bootstrap/bootstrap.rst @@ -6,10 +6,10 @@ Bootstrap :maxdepth: 2 ../config/bootstrap/v3/bootstrap.proto - ../config/metrics/v3/stats.proto + ../extensions/bootstrap/internal_listener/v3/internal_listener.proto ../config/metrics/v3/metrics_service.proto ../config/overload/v3/overload.proto ../config/ratelimit/v3/rls.proto - ../extensions/bootstrap/internal_listener/v3/internal_listener.proto + ../config/metrics/v3/stats.proto ../extensions/vcl/v3alpha/vcl_socket_interface.proto ../extensions/wasm/v3/wasm.proto diff --git a/docs/root/api-v3/clusters/clusters.rst b/docs/root/api-v3/clusters/clusters.rst index 9ebd9db910d2d..56ef8850c9cab 100644 --- a/docs/root/api-v3/clusters/clusters.rst +++ b/docs/root/api-v3/clusters/clusters.rst @@ -5,10 +5,10 @@ Clusters :glob: :maxdepth: 2 - ../config/cluster/v3/cluster.proto - ../config/cluster/v3/outlier_detection.proto ../config/cluster/v3/circuit_breaker.proto - ../config/cluster/v3/filter.proto + ../config/cluster/v3/cluster.proto ../config/endpoint/v3/endpoint.proto ../config/endpoint/v3/endpoint_components.proto ../config/core/v3/health_check.proto + ../config/cluster/v3/outlier_detection.proto + ../config/cluster/v3/filter.proto diff --git a/docs/root/api-v3/common_messages/common_messages.rst b/docs/root/api-v3/common_messages/common_messages.rst index 276949350bc6a..fbe9cc97f275b 100644 --- a/docs/root/api-v3/common_messages/common_messages.rst +++ b/docs/root/api-v3/common_messages/common_messages.rst @@ -5,54 +5,35 @@ Common messages :glob: :maxdepth: 2 - ../config/core/v3/base.proto - ../config/core/v3/extension.proto - ../config/core/v3/address.proto + ../extensions/common/async_files/v3/async_file_manager.proto ../config/core/v3/backoff.proto - ../config/core/v3/protocol.proto - ../config/core/v3/proxy_protocol.proto ../service/discovery/v3/discovery.proto - ../config/core/v3/config_source.proto - ../config/core/v3/grpc_service.proto - ../config/core/v3/grpc_method_list.proto - ../config/core/v3/http_uri.proto - ../config/core/v3/resolver.proto - ../config/core/v3/socket_option.proto - ../config/core/v3/udp_socket_config.proto - ../config/core/v3/substitution_format_string.proto - ../config/common/key_value/v3/config.proto - ../config/common/mutation_rules/v3/mutation_rules.proto - ../extensions/common/ratelimit/v3/ratelimit.proto - ../extensions/early_data/v3/default_early_data_policy.proto ../extensions/filters/common/fault/v3/fault.proto + ../config/core/v3/base.proto + ../extensions/filters/common/matcher/action/v3/skip_action.proto + ../extensions/matching/common_inputs/network/v3/network_inputs.proto + ../extensions/common/ratelimit/v3/ratelimit.proto + ../extensions/matching/common_inputs/ssl/v3/ssl_inputs.proto + ../config/core/v3/config_source.proto + ../extensions/matching/input_matchers/consistent_hashing/v3/consistent_hashing.proto ../extensions/network/socket_interface/v3/default_socket_interface.proto + ../extensions/matching/common_inputs/environment_variable/v3/input.proto + ../config/core/v3/extension.proto ../extensions/common/matching/v3/extension_matcher.proto - ../extensions/common/async_files/v3/async_file_manager.proto ../extensions/filters/common/dependency/v3/dependency.proto - ../extensions/filters/common/matcher/action/v3/skip_action.proto + ../extensions/regex_engines/v3/google_re2.proto + ../config/core/v3/grpc_method_list.proto + ../config/core/v3/grpc_service.proto ../extensions/key_value/file_based/v3/config.proto - ../extensions/matching/input_matchers/consistent_hashing/v3/consistent_hashing.proto + ../config/common/key_value/v3/config.proto + ../config/common/mutation_rules/v3/mutation_rules.proto + ../extensions/early_data/v3/default_early_data_policy.proto + ../config/core/v3/http_uri.proto ../extensions/matching/input_matchers/ip/v3/ip.proto - ../extensions/matching/common_inputs/environment_variable/v3/input.proto - ../extensions/matching/common_inputs/network/v3/network_inputs.proto - ../extensions/matching/common_inputs/ssl/v3/ssl_inputs.proto - ../extensions/regex_engines/v3/google_re2.proto - ../../xds/type/v3/cel.proto - ../../xds/type/v3/range.proto - ../../xds/type/v3/typed_struct.proto - ../../xds/type/matcher/v3/cel.proto - ../../xds/type/matcher/v3/domain.proto - ../../xds/type/matcher/v3/http_inputs.proto - ../../xds/type/matcher/v3/ip.proto - ../../xds/type/matcher/v3/matcher.proto - ../../xds/type/matcher/v3/range.proto - ../../xds/type/matcher/v3/regex.proto - ../../xds/type/matcher/v3/string.proto - ../../xds/core/v3/authority.proto - ../../xds/core/v3/cidr.proto - ../../xds/core/v3/collection_entry.proto - ../../xds/core/v3/context_params.proto - ../../xds/core/v3/extension.proto - ../../xds/core/v3/resource.proto - ../../xds/core/v3/resource_locator.proto - ../../xds/core/v3/resource_name.proto + ../config/core/v3/address.proto + ../config/core/v3/protocol.proto + ../config/core/v3/proxy_protocol.proto + ../config/core/v3/resolver.proto + ../config/core/v3/socket_option.proto + ../config/core/v3/substitution_format_string.proto + ../config/core/v3/udp_socket_config.proto diff --git a/docs/root/api-v3/common_messages/common_messages_xds.rst b/docs/root/api-v3/common_messages/common_messages_xds.rst new file mode 100644 index 0000000000000..4147798a6fe1f --- /dev/null +++ b/docs/root/api-v3/common_messages/common_messages_xds.rst @@ -0,0 +1,26 @@ +Common messages (XDS) +===================== + +.. toctree:: + :glob: + :maxdepth: 2 + + ../../xds/type/v3/cel.proto + ../../xds/type/matcher/v3/cel.proto + ../../xds/type/matcher/v3/http_inputs.proto + ../../xds/type/matcher/v3/ip.proto + ../../xds/type/v3/range.proto + ../../xds/type/matcher/v3/range.proto + ../../xds/type/matcher/v3/regex.proto + ../../xds/type/matcher/v3/domain.proto + ../../xds/type/matcher/v3/string.proto + ../../xds/type/matcher/v3/matcher.proto + ../../xds/core/v3/authority.proto + ../../xds/core/v3/cidr.proto + ../../xds/core/v3/collection_entry.proto + ../../xds/core/v3/context_params.proto + ../../xds/core/v3/extension.proto + ../../xds/core/v3/resource.proto + ../../xds/core/v3/resource_locator.proto + ../../xds/core/v3/resource_name.proto + ../../xds/type/v3/typed_struct.proto diff --git a/docs/root/api-v3/config/accesslog/filters.rst b/docs/root/api-v3/config/accesslog/filters.rst index 692d0a18586b3..597fb1501cee7 100644 --- a/docs/root/api-v3/config/accesslog/filters.rst +++ b/docs/root/api-v3/config/accesslog/filters.rst @@ -1,5 +1,5 @@ -Extension Filters -================= +Access log extension filters +============================ .. toctree:: :glob: diff --git a/docs/root/api-v3/config/accesslog/filters/filters.rst b/docs/root/api-v3/config/accesslog/filters/filters.rst index a27e04e376921..c0adcbbd9504e 100644 --- a/docs/root/api-v3/config/accesslog/filters/filters.rst +++ b/docs/root/api-v3/config/accesslog/filters/filters.rst @@ -1,5 +1,5 @@ -Extension Filters -================= +Access log extension filters +============================ .. toctree:: :glob: diff --git a/docs/root/api-v3/config/config.rst b/docs/root/api-v3/config/config.rst index 07465c083d86f..cfb4b26e6ae5c 100644 --- a/docs/root/api-v3/config/config.rst +++ b/docs/root/api-v3/config/config.rst @@ -7,37 +7,36 @@ Extensions :glob: :maxdepth: 2 - filter/filter - accesslog/accesslog accesslog/filters - rbac/rbac - health_checker/health_checker - transport_socket/transport_socket - dns_resolver/dns_resolver.rst - resource_monitor/resource_monitor + formatter/formatter + accesslog/accesslog + cluster/cluster common/common compression/compression - cluster/cluster - grpc_credential/grpc_credential - retry/retry - trace/trace - internal_redirect/internal_redirect + config_validators/config_validators + contrib/contrib + dns_resolver/dns_resolver endpoint/endpoint - upstream/upstream - wasm/wasm - watchdog/watchdog - descriptors/descriptors - request_id/request_id + filter/filter + grpc_credential/grpc_credential + health_checker/health_checker http/header_formatters + http/header_validators http/original_ip_detection http/stateful_session - http/header_validators - stat_sinks/stat_sinks - quic/quic_extensions - formatter/formatter - contrib/contrib - rbac/matchers - config_validators/config_validators + trace/trace + internal_redirect/internal_redirect path/match/path_matcher path/rewrite/path_rewriter - + quic/quic_extensions + descriptors/descriptors + rbac/rbac + rbac/matchers + request_id/request_id + resource_monitor/resource_monitor + retry/retry + stat_sinks/stat_sinks + transport_socket/transport_socket + upstream/upstream + wasm/wasm + watchdog/watchdog diff --git a/docs/root/api-v3/config/contrib/contrib.rst b/docs/root/api-v3/config/contrib/contrib.rst index 8fbe2c553f60a..b21a464649720 100644 --- a/docs/root/api-v3/config/contrib/contrib.rst +++ b/docs/root/api-v3/config/contrib/contrib.rst @@ -1,6 +1,6 @@ .. _api-v3_config_contrib: -Contrib Extensions +Contrib extensions ================== .. toctree:: diff --git a/docs/root/api-v3/config/dns_resolver/dns_resolver.rst b/docs/root/api-v3/config/dns_resolver/dns_resolver.rst index 3756a5109ca25..fbfdf70534652 100644 --- a/docs/root/api-v3/config/dns_resolver/dns_resolver.rst +++ b/docs/root/api-v3/config/dns_resolver/dns_resolver.rst @@ -1,5 +1,5 @@ -DNS Resolver -================= +DNS resolver +============ .. toctree:: :glob: diff --git a/docs/root/api-v3/config/grpc_credential/grpc_credential.rst b/docs/root/api-v3/config/grpc_credential/grpc_credential.rst index 975dae87d871c..f7856e1f9f3fb 100644 --- a/docs/root/api-v3/config/grpc_credential/grpc_credential.rst +++ b/docs/root/api-v3/config/grpc_credential/grpc_credential.rst @@ -1,4 +1,4 @@ -Grpc Credentials +Grpc credentials ================ .. toctree:: diff --git a/docs/root/api-v3/config/http/header_validators.rst b/docs/root/api-v3/config/http/header_validators.rst index 61af5bae877c4..c43e864d3cfd5 100644 --- a/docs/root/api-v3/config/http/header_validators.rst +++ b/docs/root/api-v3/config/http/header_validators.rst @@ -1,5 +1,5 @@ -Header Validators -================= +HTTP header validators +====================== .. toctree:: :glob: diff --git a/docs/root/api-v3/config/http/original_ip_detection.rst b/docs/root/api-v3/config/http/original_ip_detection.rst index 1d333c2f53c90..a14c6e2dfa0ea 100644 --- a/docs/root/api-v3/config/http/original_ip_detection.rst +++ b/docs/root/api-v3/config/http/original_ip_detection.rst @@ -1,5 +1,5 @@ -Original IP Detection -===================== +HTTP original IP detection +========================== .. toctree:: :glob: diff --git a/docs/root/api-v3/config/http/stateful_session.rst b/docs/root/api-v3/config/http/stateful_session.rst index 70a60664172f2..1282bba46ff4b 100644 --- a/docs/root/api-v3/config/http/stateful_session.rst +++ b/docs/root/api-v3/config/http/stateful_session.rst @@ -1,4 +1,4 @@ -Stateful Session +HTTP stateful session ===================== .. toctree:: diff --git a/docs/root/api-v3/config/internal_redirect/internal_redirect.rst b/docs/root/api-v3/config/internal_redirect/internal_redirect.rst index 5452e8accee74..5f5a74006fe87 100644 --- a/docs/root/api-v3/config/internal_redirect/internal_redirect.rst +++ b/docs/root/api-v3/config/internal_redirect/internal_redirect.rst @@ -1,4 +1,4 @@ -Internal Redirect Predicates +Internal redirect predicates ============================ .. toctree:: diff --git a/docs/root/api-v3/config/path/match/path_matcher.rst b/docs/root/api-v3/config/path/match/path_matcher.rst index 68800d0a68f2c..72384369da5e9 100644 --- a/docs/root/api-v3/config/path/match/path_matcher.rst +++ b/docs/root/api-v3/config/path/match/path_matcher.rst @@ -1,5 +1,5 @@ -Path Matcher -================= +Path matcher +============ .. toctree:: :glob: diff --git a/docs/root/api-v3/config/path/rewrite/path_rewriter.rst b/docs/root/api-v3/config/path/rewrite/path_rewriter.rst index 01e7d1086561f..6da4eebef3da4 100644 --- a/docs/root/api-v3/config/path/rewrite/path_rewriter.rst +++ b/docs/root/api-v3/config/path/rewrite/path_rewriter.rst @@ -1,5 +1,5 @@ -Path Rewriter -================= +Path rewriter +============= .. toctree:: :glob: diff --git a/docs/root/api-v3/config/quic/quic_extensions.rst b/docs/root/api-v3/config/quic/quic_extensions.rst index 4f3ab247bb6da..59706c6c690c3 100644 --- a/docs/root/api-v3/config/quic/quic_extensions.rst +++ b/docs/root/api-v3/config/quic/quic_extensions.rst @@ -1,5 +1,5 @@ -Quic Extensions -================= +Quic extensions +=============== .. toctree:: :glob: diff --git a/docs/root/api-v3/config/retry/retry.rst b/docs/root/api-v3/config/retry/retry.rst index 2ba4572ab2edc..73f2ef1bcb66c 100644 --- a/docs/root/api-v3/config/retry/retry.rst +++ b/docs/root/api-v3/config/retry/retry.rst @@ -1,4 +1,4 @@ -Retry Predicates +Retry predicates ================ .. toctree:: diff --git a/docs/root/api-v3/config/trace/trace.rst b/docs/root/api-v3/config/trace/trace.rst index b31b60a1df99f..8f8d039a18d81 100644 --- a/docs/root/api-v3/config/trace/trace.rst +++ b/docs/root/api-v3/config/trace/trace.rst @@ -1,7 +1,7 @@ .. _http_tracers: -HTTP Tracers -============== +HTTP tracers +============ .. note:: diff --git a/docs/root/api-v3/config/upstream/upstream.rst b/docs/root/api-v3/config/upstream/upstream.rst index 897cc26b6e96c..bd253380a1306 100644 --- a/docs/root/api-v3/config/upstream/upstream.rst +++ b/docs/root/api-v3/config/upstream/upstream.rst @@ -1,4 +1,4 @@ -Upstream Configuration +Upstream configuration ====================== .. toctree:: diff --git a/docs/root/api-v3/http_routes/http_routes.rst b/docs/root/api-v3/http_routes/http_routes.rst index 006d4610395e1..db0f26ce0f5e7 100644 --- a/docs/root/api-v3/http_routes/http_routes.rst +++ b/docs/root/api-v3/http_routes/http_routes.rst @@ -5,6 +5,6 @@ HTTP route management :glob: :maxdepth: 2 + ../config/route/v3/route_components.proto ../config/route/v3/route.proto ../config/route/v3/scoped_route.proto - ../config/route/v3/route_components.proto diff --git a/docs/root/api-v3/listeners/listeners.rst b/docs/root/api-v3/listeners/listeners.rst index eeb3af6e0d51a..7c0a68a52be03 100644 --- a/docs/root/api-v3/listeners/listeners.rst +++ b/docs/root/api-v3/listeners/listeners.rst @@ -5,11 +5,11 @@ Listeners :glob: :maxdepth: 2 - ../config/listener/v3/listener.proto - ../config/listener/v3/listener_components.proto ../config/listener/v3/api_listener.proto - ../config/listener/v3/udp_listener_config.proto - ../config/listener/v3/quic_config.proto ../extensions/network/connection_balance/dlb/v3alpha/dlb.proto + ../config/listener/v3/listener_components.proto + ../config/listener/v3/listener.proto + ../config/listener/v3/quic_config.proto ../extensions/udp_packet_writer/v3/udp_gso_batch_writer_factory.proto + ../config/listener/v3/udp_listener_config.proto ../extensions/udp_packet_writer/v3/udp_default_writer_factory.proto diff --git a/docs/root/api-v3/service/service.rst b/docs/root/api-v3/service/service.rst index a65686099df1f..d26d19eabe939 100644 --- a/docs/root/api-v3/service/service.rst +++ b/docs/root/api-v3/service/service.rst @@ -5,16 +5,16 @@ Services :glob: :maxdepth: 2 - accesslog/v3/* - load_stats/v3/* auth/v3/* + status/v3/* + extension/v3/* + ext_proc/v3/* + accesslog/v3/* health/v3/* + load_stats/v3/* metrics/v3/* ratelimit/v3/* runtime/v3/* - status/v3/* - tap/v3/* ../config/tap/v3/* + tap/v3/* trace/v3/* - extension/v3/* - ext_proc/v3/* diff --git a/docs/root/api-v3/types/types.rst b/docs/root/api-v3/types/types.rst index a86620519ff87..081171a162d77 100644 --- a/docs/root/api-v3/types/types.rst +++ b/docs/root/api-v3/types/types.rst @@ -5,24 +5,24 @@ Types :glob: :maxdepth: 2 + ../type/matcher/v3/http_inputs.proto + ../type/tracing/v3/custom_tag.proto ../type/v3/hash_policy.proto ../type/v3/http.proto ../type/v3/http_status.proto - ../type/v3/percent.proto - ../type/v3/range.proto - ../type/v3/ratelimit_unit.proto - ../type/v3/semantic_version.proto - ../type/v3/token_bucket.proto ../type/http/v3/cookie.proto - ../type/http/v3/path_transformation.proto + ../type/metadata/v3/metadata.proto ../type/matcher/v3/metadata.proto ../type/matcher/v3/node.proto ../type/matcher/v3/number.proto ../type/matcher/v3/path.proto + ../type/http/v3/path_transformation.proto + ../type/v3/percent.proto + ../type/v3/range.proto + ../type/v3/ratelimit_unit.proto ../type/matcher/v3/regex.proto + ../type/v3/semantic_version.proto ../type/matcher/v3/string.proto ../type/matcher/v3/struct.proto + ../type/v3/token_bucket.proto ../type/matcher/v3/value.proto - ../type/matcher/v3/http_inputs.proto - ../type/metadata/v3/metadata.proto - ../type/tracing/v3/custom_tag.proto