add comments

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>
envoyproxy · May 8, 2024 · 3acc783 · 3acc783
1 parent b96bdc0
commit 3acc783
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/api/v1alpha1/authorization_types.go b/api/v1alpha1/authorization_types.go
@@ -8,7 +8,8 @@ package v1alpha1
 // Authorization defines the authorization configuration.
 type Authorization struct {
 	// Rules contains all the authorization rules.
-	// Rules are evaluated in order, the first matching rule will be applied.
+	// Rules are evaluated in order, the first matching rule will be applied,
+	// and the rest will be skipped.
 	//
 	// +kubebuilder:validation:MinItems=1
 	Rules []Rule `json:"rules,omitempty"`

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml
@@ -55,7 +55,8 @@ spec:
                   rules:
                     description: |-
                       Rules contains all the authorization rules.
-                      Rules are evaluated in order, the first matching rule will be applied.
+                      Rules are evaluated in order, the first matching rule will be applied,
+                      and the rest will be skipped.
                     items:
                       description: Rule defines the single authorization rule.
                       properties:

diff --git a/site/content/en/latest/api/extension_types.md b/site/content/en/latest/api/extension_types.md
@@ -182,7 +182,7 @@ _Appears in:_
 
 | Field | Type | Required | Description |
 | ---   | ---  | ---      | ---         |
-| `rules` | _[Rule](#rule) array_ |  true  | Rules contains all the authorization rules.<br />Rules are evaluated in order, the first matching rule will be applied. |
+| `rules` | _[Rule](#rule) array_ |  true  | Rules contains all the authorization rules.<br />Rules are evaluated in order, the first matching rule will be applied,<br />and the rest will be skipped. |
 
 
 #### BackOffPolicy