api: spell check api comments (#5701)

Signed-off-by: Stephan Zuercher <zuercher@gmail.com>

Mirrored from https://github.com/envoyproxy/envoy @ 698009170e362f9ca0594f2b1927fbbee199bf98
pull/620/head
data-plane-api(CircleCI) 6 years ago
parent dba614c294
commit 6b03b7d632
  1. 2
      STYLE.md
  2. 2
      envoy/api/v2/cds.proto
  3. 2
      envoy/api/v2/core/address.proto
  4. 2
      envoy/api/v2/core/config_source.proto
  5. 2
      envoy/api/v2/core/health_check.proto
  6. 2
      envoy/api/v2/discovery.proto
  7. 2
      envoy/api/v2/endpoint/endpoint.proto
  8. 2
      envoy/api/v2/lds.proto
  9. 4
      envoy/api/v2/route/route.proto
  10. 12
      envoy/config/filter/http/ext_authz/v2/ext_authz.proto
  11. 2
      envoy/config/filter/network/dubbo_proxy/v2alpha1/route.proto
  12. 4
      envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto
  13. 2
      envoy/config/filter/network/thrift_proxy/v2alpha1/route.proto
  14. 2
      envoy/config/metrics/v2/stats.proto
  15. 2
      envoy/service/discovery/v2/hds.proto

@ -87,7 +87,7 @@ In addition, the following conventions should be followed:
* Prefer `oneof` selections to boolean overloads of fields, for example, prefer: * Prefer `oneof` selections to boolean overloads of fields, for example, prefer:
```proto ```proto
oneof path_secifier { oneof path_specifier {
string simple_path = 1; string simple_path = 1;
string regex_path = 2; string regex_path = 2;
} }

@ -435,7 +435,7 @@ message Cluster {
// :ref:`Original Destination <arch_overview_load_balancing_types_original_destination>` // :ref:`Original Destination <arch_overview_load_balancing_types_original_destination>`
// load balancing policy. // load balancing policy.
message OriginalDstLbConfig { message OriginalDstLbConfig {
// When true, :ref:`x-envoy-orignal-dst-host // When true, :ref:`x-envoy-original-dst-host
// <config_http_conn_man_headers_x-envoy-original-dst-host>` can be used to override destination // <config_http_conn_man_headers_x-envoy-original-dst-host>` can be used to override destination
// address. // address.
// //

@ -56,7 +56,7 @@ message SocketAddress {
// IP address, no resolution will occur. // IP address, no resolution will occur.
string resolver_name = 5; string resolver_name = 5;
// When binding to an IPv6 address above, this enables `IPv4 compatibity // When binding to an IPv6 address above, this enables `IPv4 compatibility
// <https://tools.ietf.org/html/rfc3493#page-11>`_. Binding to ``::`` will // <https://tools.ietf.org/html/rfc3493#page-11>`_. Binding to ``::`` will
// allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into // allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into
// IPv6 space as ``::FFFF:<IPv4-address>``. // IPv6 space as ``::FFFF:<IPv4-address>``.

@ -65,7 +65,7 @@ message AggregatedConfigSource {
// Rate Limit settings to be applied for discovery requests made by Envoy. // Rate Limit settings to be applied for discovery requests made by Envoy.
message RateLimitSettings { message RateLimitSettings {
// Maximum number of tokens to be used for rate limting discovery request calls. If not set, a // Maximum number of tokens to be used for rate limiting discovery request calls. If not set, a
// default value of 100 will be used. // default value of 100 will be used.
google.protobuf.UInt32Value max_tokens = 1; google.protobuf.UInt32Value max_tokens = 1;

@ -40,7 +40,7 @@ message HealthCheck {
(gogoproto.stdduration) = true (gogoproto.stdduration) = true
]; ];
// An optional jitter amount in millseconds. If specified, during every // An optional jitter amount in milliseconds. If specified, during every
// interval Envoy will add interval_jitter to the wait time. // interval Envoy will add interval_jitter to the wait time.
google.protobuf.Duration interval_jitter = 3; google.protobuf.Duration interval_jitter = 3;

@ -110,7 +110,7 @@ message DiscoveryResponse {
// //
// In Incremental xDS the nonce field is required and used to pair // In Incremental xDS the nonce field is required and used to pair
// IncrementalDiscoveryResponse to a IncrementalDiscoveryRequest ACK or NACK. // IncrementalDiscoveryResponse to a IncrementalDiscoveryRequest ACK or NACK.
// Optionaly, a response message level system_version_info is present for // Optionally, a response message level system_version_info is present for
// debugging purposes only. // debugging purposes only.
// //
// IncrementalDiscoveryRequest can be sent in 3 situations: // IncrementalDiscoveryRequest can be sent in 3 situations:

@ -108,7 +108,7 @@ message LocalityLbEndpoints {
// Locality weights are only considered when :ref:`locality weighted load // Locality weights are only considered when :ref:`locality weighted load
// balancing <arch_overview_load_balancing_locality_weighted_lb>` is // balancing <arch_overview_load_balancing_locality_weighted_lb>` is
// configured. These weights are ignored otherwise. If no weights are // configured. These weights are ignored otherwise. If no weights are
// specificed when locality weighted load balancing is enabled, the cluster is // specified when locality weighted load balancing is enabled, the cluster is
// assumed to have a weight of 1. // assumed to have a weight of 1.
// //
// .. attention:: // .. attention::

@ -89,7 +89,7 @@ message Listener {
// [#not-implemented-hide:] // [#not-implemented-hide:]
message DeprecatedV1 { message DeprecatedV1 {
// Whether the listener should bind to the port. A listener that doesnt // Whether the listener should bind to the port. A listener that doesn't
// bind can only receive connections redirected from other listeners that // bind can only receive connections redirected from other listeners that
// set use_original_dst parameter to true. Default is true. // set use_original_dst parameter to true. Default is true.
// //

@ -340,7 +340,7 @@ message RouteMatch {
// Indicates that the route should additionally match on a runtime key. Every time the route // Indicates that the route should additionally match on a runtime key. Every time the route
// is considered for a match, it must also fall under the percentage of matches indicated by // is considered for a match, it must also fall under the percentage of matches indicated by
// this field. For some fraction N/D, a random number in the range [0,D) is selected. If the // this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
// number is <= the value of the numberator N, or if the key is not present, the default // number is <= the value of the numerator N, or if the key is not present, the default
// value, the router continues to evaluate the remaining match criteria. A runtime_fraction // value, the router continues to evaluate the remaining match criteria. A runtime_fraction
// route configuration can be used to roll out route changes in a gradual manner without full // route configuration can be used to roll out route changes in a gradual manner without full
// code/config deploys. Refer to the :ref:`traffic shifting // code/config deploys. Refer to the :ref:`traffic shifting
@ -601,7 +601,7 @@ message RouteAction {
// fall under the percentage of matches indicated by this field. // fall under the percentage of matches indicated by this field.
// //
// For some fraction N/D, a random number in the range [0,D) is selected. If the // For some fraction N/D, a random number in the range [0,D) is selected. If the
// number is <= the value of the numberator N, or if the key is not present, the default // number is <= the value of the numerator N, or if the key is not present, the default
// value, the request will be mirrored. // value, the request will be mirrored.
// //
// .. note:: // .. note::

@ -40,16 +40,16 @@ message ExtAuthz {
bool failure_mode_allow = 2; bool failure_mode_allow = 2;
} }
// HttpService is used for raw HTTP comunication between the filter and the authorization service. // HttpService is used for raw HTTP communication between the filter and the authorization service.
// When configured, the filter will parse the client request and use these attributes to call the // When configured, the filter will parse the client request and use these attributes to call the
// authorization server. Depending on the response, the filter may reject or accept the client // authorization server. Depending on the response, the filter may reject or accept the client
// request. Note that in any of these events, metadata can be added, removed or overriden by the // request. Note that in any of these events, metadata can be added, removed or overridden by the
// filter: // filter:
// //
// *On authorization request*, a list of allowed request headers may be supplied. See // *On authorization request*, a list of allowed request headers may be supplied. See
// :ref:`allowed_headers // :ref:`allowed_headers
// <envoy_api_field_config.filter.http.ext_authz.v2.AuthorizationRequest.allowed_headers>` // <envoy_api_field_config.filter.http.ext_authz.v2.AuthorizationRequest.allowed_headers>`
// for details. Additional headers metadata may be added to the authorization resquest. See // for details. Additional headers metadata may be added to the authorization request. See
// :ref:`headers_to_add // :ref:`headers_to_add
// <envoy_api_field_config.filter.http.ext_authz.v2.AuthorizationRequest.headers_to_add>` for // <envoy_api_field_config.filter.http.ext_authz.v2.AuthorizationRequest.headers_to_add>` for
// details. // details.
@ -96,14 +96,14 @@ message AuthorizationRequest {
envoy.type.matcher.ListStringMatcher allowed_headers = 1; envoy.type.matcher.ListStringMatcher allowed_headers = 1;
// Sets a list of headers that will be included to the request to authorization service. Note that // Sets a list of headers that will be included to the request to authorization service. Note that
// client request of the same key will be overriden. // client request of the same key will be overridden.
repeated envoy.api.v2.core.HeaderValue headers_to_add = 2; repeated envoy.api.v2.core.HeaderValue headers_to_add = 2;
} }
message AuthorizationResponse { message AuthorizationResponse {
// When this :ref:`list <envoy_api_msg_type.matcher.ListStringMatcher>` is set, authorization // When this :ref:`list <envoy_api_msg_type.matcher.ListStringMatcher>` is set, authorization
// response headers that have a correspondent match will be added to the original client request. // response headers that have a correspondent match will be added to the original client request.
// Note that coexistent headers will be overriden. // Note that coexistent headers will be overridden.
envoy.type.matcher.ListStringMatcher allowed_upstream_headers = 1; envoy.type.matcher.ListStringMatcher allowed_upstream_headers = 1;
// When this :ref:`list <envoy_api_msg_type.matcher.ListStringMatcher>`. is set, authorization // When this :ref:`list <envoy_api_msg_type.matcher.ListStringMatcher>`. is set, authorization
@ -114,7 +114,7 @@ message AuthorizationResponse {
envoy.type.matcher.ListStringMatcher allowed_client_headers = 2; envoy.type.matcher.ListStringMatcher allowed_client_headers = 2;
} }
// Extra settings on a per virtualhost/route/weighter-cluster level. // Extra settings on a per virtualhost/route/weighted-cluster level.
message ExtAuthzPerRoute { message ExtAuthzPerRoute {
oneof override { oneof override {
option (validate.required) = true; option (validate.required) = true;

@ -34,7 +34,7 @@ message RouteConfiguration {
} }
message Route { message Route {
// Route matching prarameters. // Route matching parameters.
RouteMatch match = 1 [(validate.rules).message.required = true, (gogoproto.nullable) = false]; RouteMatch match = 1 [(validate.rules).message.required = true, (gogoproto.nullable) = false];
// Route request to some upstream cluster. // Route request to some upstream cluster.

@ -197,7 +197,7 @@ message HttpConnectionManager {
// during which Envoy will flush the write buffers for the connection and await the peer to close // during which Envoy will flush the write buffers for the connection and await the peer to close
// (i.e., a TCP FIN/RST is received by Envoy from the downstream connection). // (i.e., a TCP FIN/RST is received by Envoy from the downstream connection).
// //
// Delaying Envoy's connection close and giving the peer the opportunity to initate the close // Delaying Envoy's connection close and giving the peer the opportunity to initiate the close
// sequence mitigates a race condition that exists when downstream clients do not drain/process // sequence mitigates a race condition that exists when downstream clients do not drain/process
// data in a connection's receive buffer after a remote close has been detected via a socket // data in a connection's receive buffer after a remote close has been detected via a socket
// write(). This race leads to such clients failing to process the response code sent by Envoy, // write(). This race leads to such clients failing to process the response code sent by Envoy,
@ -364,7 +364,7 @@ message HttpConnectionManager {
// HTTP connections will be used for this upgrade type. // HTTP connections will be used for this upgrade type.
repeated HttpFilter filters = 2; repeated HttpFilter filters = 2;
// Determines if upgrades are enabled or disabled by default. Defaults to true. // Determines if upgrades are enabled or disabled by default. Defaults to true.
// This can be overriden on a per-route basis with :ref:`cluster // This can be overridden on a per-route basis with :ref:`cluster
// <envoy_api_field_route.RouteAction.upgrade_configs>` as documented in the // <envoy_api_field_route.RouteAction.upgrade_configs>` as documented in the
// :ref:`upgrade documentation <arch_overview_websocket>`. // :ref:`upgrade documentation <arch_overview_websocket>`.
google.protobuf.BoolValue enabled = 3; google.protobuf.BoolValue enabled = 3;

@ -27,7 +27,7 @@ message RouteConfiguration {
// [#comment:next free field: 3] // [#comment:next free field: 3]
message Route { message Route {
// Route matching prarameters. // Route matching parameters.
RouteMatch match = 1 [(validate.rules).message.required = true, (gogoproto.nullable) = false]; RouteMatch match = 1 [(validate.rules).message.required = true, (gogoproto.nullable) = false];
// Route request to some upstream cluster. // Route request to some upstream cluster.

@ -323,7 +323,7 @@ message HystrixSink {
// //
// rolling_window(ms) = stats_flush_interval(ms) * num_of_buckets // rolling_window(ms) = stats_flush_interval(ms) * num_of_buckets
// //
// More detailed explanation can be found in `Hystix wiki // More detailed explanation can be found in `Hystrix wiki
// <https://github.com/Netflix/Hystrix/wiki/Metrics-and-Monitoring#hystrixrollingnumber>`_. // <https://github.com/Netflix/Hystrix/wiki/Metrics-and-Monitoring#hystrixrollingnumber>`_.
int64 num_buckets = 1; int64 num_buckets = 1;
} }

@ -35,7 +35,7 @@ service HealthDiscoveryService {
// it to endpoint(ip:port) of Host 1 and 2. Based on the HealthCheck // it to endpoint(ip:port) of Host 1 and 2. Based on the HealthCheck
// configuration Envoy waits upon the arrival of the probe response and // configuration Envoy waits upon the arrival of the probe response and
// looks at the content of the response to decide whether the endpoint is // looks at the content of the response to decide whether the endpoint is
// healthy or not. If a response hasnt been received within the timeout // healthy or not. If a response hasn't been received within the timeout
// interval, the endpoint health status is considered TIMEOUT. // interval, the endpoint health status is considered TIMEOUT.
// 4. Envoy reports results back in an EndpointHealthResponse message. // 4. Envoy reports results back in an EndpointHealthResponse message.
// Envoy streams responses as often as the interval configured by the // Envoy streams responses as often as the interval configured by the

Loading…
Cancel
Save