polish comments

Signed-off-by: Megrez Lu <[email protected]>
openkruise · May 14, 2024 · 8e02b8b · 8e02b8b
1 parent d6db4dd
commit 8e02b8b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 10 deletions.
diff --git a/api/v1beta1/rollout_types.go b/api/v1beta1/rollout_types.go
@@ -146,12 +146,11 @@ type TrafficRoutingStrategy struct {
 	//
 	// +optional
 	RequestHeaderModifier *gatewayv1beta1.HTTPRequestHeaderFilter `json:"requestHeaderModifier,omitempty"`
-	// Matches define conditions used for matching the incoming HTTP requests to canary service.
-	// Each match is independent, i.e. this rule will be matched if **any** one of the matches is satisfied.
+	// Matches define conditions used for matching incoming HTTP requests to the canary service.
+	// Each match is independent, i.e. this rule will be matched as long as **any** one of the matches is satisfied.
 	//
 	// For Gateway API, only a single match rule will be applied since Gateway API use ANDed rules if multiple
 	// ones are defined, i.e. the match will evaluate to true only if all conditions are satisfied.
-	// Header (for backwards-compatibility) > QueryParams
 	// And cannot support both weight and matches, if both are configured, then matches takes precedence.
 	Matches []HttpRouteMatch `json:"matches,omitempty"`
 }

diff --git a/config/crd/bases/rollouts.kruise.io_rollouts.yaml b/config/crd/bases/rollouts.kruise.io_rollouts.yaml
@@ -623,14 +623,13 @@ spec:
                           properties:
                             matches:
                               description: "Matches define conditions used for matching
-                                the incoming HTTP requests to canary service. Each
+                                incoming HTTP requests to the canary service. Each
                                 match is independent, i.e. this rule will be matched
-                                if **any** one of the matches is satisfied. \n For
-                                Gateway API, only a single match rule will be applied
-                                since Gateway API use ANDed rules if multiple ones
-                                are defined, i.e. the match will evaluate to true
-                                only if all conditions are satisfied. Header (for
-                                backwards-compatibility) > QueryParams And cannot
+                                as long as **any** one of the matches is satisfied.
+                                \n For Gateway API, only a single match rule will
+                                be applied since Gateway API use ANDed rules if multiple
+                                ones are defined, i.e. the match will evaluate to
+                                true only if all conditions are satisfied. And cannot
                                 support both weight and matches, if both are configured,
                                 then matches takes precedence."
                               items: