fix api nit (envoyproxy#3497)

Signed-off-by: zirain <zirain2009@gmail.com>
guydc · May 29, 2024 · 6f30397 · 6f30397
1 parent 44330ef
commit 6f30397
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 22 deletions.
diff --git a/api/v1alpha1/accesslogging_types.go b/api/v1alpha1/accesslogging_types.go
@@ -171,7 +171,7 @@ type OpenTelemetryEnvoyProxyAccessLog struct {
 	Port int32 `json:"port,omitempty"`
 	// BackendRefs references a Kubernetes object that represents the
 	// backend server to which the access log will be sent.
-	// Only service Kind is supported for now.
+	// Only Service kind is supported for now.
 	//
 	// +optional
 	// +kubebuilder:validation:MaxItems=1

diff --git a/api/v1alpha1/envoyproxy_metric_types.go b/api/v1alpha1/envoyproxy_metric_types.go
@@ -70,7 +70,7 @@ type ProxyOpenTelemetrySink struct {
 	Port int32 `json:"port,omitempty"`
 	// BackendRefs references a Kubernetes object that represents the
 	// backend server to which the metric will be sent.
-	// Only service Kind is supported for now.
+	// Only Service kind is supported for now.
 	//
 	// +optional
 	// +kubebuilder:validation:MaxItems=1

diff --git a/api/v1alpha1/ext_auth_types.go b/api/v1alpha1/ext_auth_types.go
@@ -59,13 +59,14 @@ type ExtAuth struct {
 type GRPCExtAuthService struct {
 	// BackendRef references a Kubernetes object that represents the
 	// backend server to which the authorization request will be sent.
-	// Only service Kind is supported for now.
+	// Only Service kind is supported for now.
+	//
 	// Deprecated: Use BackendRefs instead.
 	BackendRef *gwapiv1.BackendObjectReference `json:"backendRef,omitempty"`
 
 	// BackendRefs references a Kubernetes object that represents the
 	// backend server to which the authorization request will be sent.
-	// Only service Kind is supported for now.
+	// Only Service kind is supported for now.
 	//
 	// +optional
 	// +kubebuilder:validation:MaxItems=1
@@ -79,13 +80,14 @@ type GRPCExtAuthService struct {
 type HTTPExtAuthService struct {
 	// BackendRef references a Kubernetes object that represents the
 	// backend server to which the authorization request will be sent.
-	// Only service Kind is supported for now.
+	// Only Service kind is supported for now.
+	//
 	// Deprecated: Use BackendRefs instead.
 	BackendRef *gwapiv1.BackendObjectReference `json:"backendRef,omitempty"`
 
 	// BackendRefs references a Kubernetes object that represents the
 	// backend server to which the authorization request will be sent.
-	// Only service Kind is supported for now.
+	// Only Service kind is supported for now.
 	//
 	// +optional
 	// +kubebuilder:validation:MaxItems=1

diff --git a/api/v1alpha1/shared_types.go b/api/v1alpha1/shared_types.go
@@ -443,7 +443,7 @@ type KubernetesPatchSpec struct {
 // BackendRef defines how an ObjectReference that is specific to BackendRef.
 type BackendRef struct {
 	// BackendObjectReference references a Kubernetes object that represents the backend.
-	// Only service Kind is supported for now.
+	// Only Service kind is supported for now.
 	gwapiv1.BackendObjectReference `json:",inline"`
 }
 

diff --git a/api/v1alpha1/tracing_types.go b/api/v1alpha1/tracing_types.go
@@ -51,7 +51,7 @@ type TracingProvider struct {
 	Port int32 `json:"port,omitempty"`
 	// BackendRefs references a Kubernetes object that represents the
 	// backend server to which the trace will be sent.
-	// Only service Kind is supported for now.
+	// Only Service kind is supported for now.
 	//
 	// +optional
 	// +kubebuilder:validation:MaxItems=1

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyproxies.yaml
@@ -10406,7 +10406,7 @@ spec:
                                         description: |-
                                           BackendRefs references a Kubernetes object that represents the
                                           backend server to which the access log will be sent.
-                                          Only service Kind is supported for now.
+                                          Only Service kind is supported for now.
                                         items:
                                           description: BackendRef defines how an ObjectReference
                                             that is specific to BackendRef.
@@ -10633,7 +10633,7 @@ spec:
                                   description: |-
                                     BackendRefs references a Kubernetes object that represents the
                                     backend server to which the metric will be sent.
-                                    Only service Kind is supported for now.
+                                    Only Service kind is supported for now.
                                   items:
                                     description: BackendRef defines how an ObjectReference
                                       that is specific to BackendRef.
@@ -10829,7 +10829,7 @@ spec:
                             description: |-
                               BackendRefs references a Kubernetes object that represents the
                               backend server to which the trace will be sent.
-                              Only service Kind is supported for now.
+                              Only Service kind is supported for now.
                             items:
                               description: BackendRef defines how an ObjectReference
                                 that is specific to BackendRef.

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml
@@ -259,7 +259,9 @@ spec:
                         description: |-
                           BackendRef references a Kubernetes object that represents the
                           backend server to which the authorization request will be sent.
-                          Only service Kind is supported for now.
+                          Only Service kind is supported for now.
+
+
                           Deprecated: Use BackendRefs instead.
                         properties:
                           group:
@@ -339,7 +341,7 @@ spec:
                         description: |-
                           BackendRefs references a Kubernetes object that represents the
                           backend server to which the authorization request will be sent.
-                          Only service Kind is supported for now.
+                          Only Service kind is supported for now.
                         items:
                           description: BackendRef defines how an ObjectReference that
                             is specific to BackendRef.
@@ -451,7 +453,9 @@ spec:
                         description: |-
                           BackendRef references a Kubernetes object that represents the
                           backend server to which the authorization request will be sent.
-                          Only service Kind is supported for now.
+                          Only Service kind is supported for now.
+
+
                           Deprecated: Use BackendRefs instead.
                         properties:
                           group:
@@ -531,7 +535,7 @@ spec:
                         description: |-
                           BackendRefs references a Kubernetes object that represents the
                           backend server to which the authorization request will be sent.
-                          Only service Kind is supported for now.
+                          Only Service kind is supported for now.
                         items:
                           description: BackendRef defines how an ObjectReference that
                             is specific to BackendRef.

diff --git a/site/content/en/latest/api/extension_types.md b/site/content/en/latest/api/extension_types.md
@@ -1639,8 +1639,8 @@ _Appears in:_
 
 | Field | Type | Required | Description |
 | ---   | ---  | ---      | ---         |
-| `backendRef` | _[BackendObjectReference](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1.BackendObjectReference)_ |  true  | BackendRef references a Kubernetes object that represents the<br />backend server to which the authorization request will be sent.<br />Only service Kind is supported for now.<br />Deprecated: Use BackendRefs instead. |
-| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the authorization request will be sent.<br />Only service Kind is supported for now. |
+| `backendRef` | _[BackendObjectReference](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1.BackendObjectReference)_ |  true  | BackendRef references a Kubernetes object that represents the<br />backend server to which the authorization request will be sent.<br />Only Service kind is supported for now.<br /><br />Deprecated: Use BackendRefs instead. |
+| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the authorization request will be sent.<br />Only Service kind is supported for now. |
 
 
 #### Gateway
@@ -1802,8 +1802,8 @@ _Appears in:_
 
 | Field | Type | Required | Description |
 | ---   | ---  | ---      | ---         |
-| `backendRef` | _[BackendObjectReference](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1.BackendObjectReference)_ |  true  | BackendRef references a Kubernetes object that represents the<br />backend server to which the authorization request will be sent.<br />Only service Kind is supported for now.<br />Deprecated: Use BackendRefs instead. |
-| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the authorization request will be sent.<br />Only service Kind is supported for now. |
+| `backendRef` | _[BackendObjectReference](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1.BackendObjectReference)_ |  true  | BackendRef references a Kubernetes object that represents the<br />backend server to which the authorization request will be sent.<br />Only Service kind is supported for now.<br /><br />Deprecated: Use BackendRefs instead. |
+| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the authorization request will be sent.<br />Only Service kind is supported for now. |
 | `path` | _string_ |  true  | Path is the path of the HTTP External Authorization service.<br />If path is specified, the authorization request will be sent to that path,<br />or else the authorization request will be sent to the root path. |
 | `headersToBackend` | _string array_ |  false  | HeadersToBackend are the authorization response headers that will be added<br />to the original client request before sending it to the backend server.<br />Note that coexisting headers will be overridden.<br />If not specified, no authorization response headers will be added to the<br />original client request. |
 
@@ -2412,7 +2412,7 @@ _Appears in:_
 | ---   | ---  | ---      | ---         |
 | `host` | _string_ |  false  | Host define the extension service hostname.<br />Deprecated: Use BackendRefs instead. |
 | `port` | _integer_ |  false  | Port defines the port the extension service is exposed on.<br />Deprecated: Use BackendRefs instead. |
-| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the access log will be sent.<br />Only service Kind is supported for now. |
+| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the access log will be sent.<br />Only Service kind is supported for now. |
 | `resources` | _object (keys:string, values:string)_ |  false  | Resources is a set of labels that describe the source of a log entry, including envoy node info.<br />It's recommended to follow [semantic conventions](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/). |
 
 
@@ -2750,7 +2750,7 @@ _Appears in:_
 | ---   | ---  | ---      | ---         |
 | `host` | _string_ |  false  | Host define the service hostname.<br />Deprecated: Use BackendRefs instead. |
 | `port` | _integer_ |  false  | Port defines the port the service is exposed on.<br />Deprecated: Use BackendRefs instead. |
-| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the metric will be sent.<br />Only service Kind is supported for now. |
+| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the metric will be sent.<br />Only Service kind is supported for now. |
 
 
 #### ProxyPrometheusProvider
@@ -3468,7 +3468,7 @@ _Appears in:_
 | `type` | _[TracingProviderType](#tracingprovidertype)_ |  true  | Type defines the tracing provider type.<br />EG currently only supports OpenTelemetry. |
 | `host` | _string_ |  false  | Host define the provider service hostname.<br />Deprecated: Use BackendRefs instead. |
 | `port` | _integer_ |  false  | Port defines the port the provider service is exposed on.<br />Deprecated: Use BackendRefs instead. |
-| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the trace will be sent.<br />Only service Kind is supported for now. |
+| `backendRefs` | _[BackendRef](#backendref) array_ |  false  | BackendRefs references a Kubernetes object that represents the<br />backend server to which the trace will be sent.<br />Only Service kind is supported for now. |
 
 
 #### TracingProviderType