fix comments in loadbalancer api (#2145)

Signed-off-by: zhaonan <zhaonan06@corp.netease.com>
envoyproxy · Nov 1, 2023 · 77bcb3c · 77bcb3c
1 parent 93a12e7
commit 77bcb3c
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/api/v1alpha1/loadbalancer_types.go b/api/v1alpha1/loadbalancer_types.go
@@ -11,7 +11,7 @@ package v1alpha1
 // +kubebuilder:validation:XValidation:rule="self.type == 'ConsistentHash' ? has(self.consistentHash) : !has(self.consistentHash)",message="If LoadBalancer type is consistentHash, consistentHash field needs to be set."
 type LoadBalancer struct {
 	// Type decides the type of Load Balancer policy.
-	// Valid RateLimitType values are
+	// Valid LoadBalancerType values are
 	// "ConsistentHash",
 	// "LeastRequest",
 	// "Random",

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml
@@ -63,8 +63,8 @@ spec:
                     type: object
                   type:
                     description: Type decides the type of Load Balancer policy. Valid
-                      RateLimitType values are "ConsistentHash", "LeastRequest", "Random",
-                      "RoundRobin",
+                      LoadBalancerType values are "ConsistentHash", "LeastRequest",
+                      "Random", "RoundRobin",
                     enum:
                     - ConsistentHash
                     - LeastRequest

diff --git a/site/content/en/latest/api/extension_types.md b/site/content/en/latest/api/extension_types.md
@@ -1032,7 +1032,7 @@ _Appears in:_
 
 | Field | Description |
 | --- | --- |
-| `type` _[LoadBalancerType](#loadbalancertype)_ | Type decides the type of Load Balancer policy. Valid RateLimitType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin", |
+| `type` _[LoadBalancerType](#loadbalancertype)_ | Type decides the type of Load Balancer policy. Valid LoadBalancerType values are "ConsistentHash", "LeastRequest", "Random", "RoundRobin", |
 | `consistentHash` _[ConsistentHash](#consistenthash)_ | ConsistentHash defines the configuration when the load balancer type is set to ConsistentHash |