chore: update api doc (envoyproxy#2542)

* chore: update api doc Signed-off-by: zirain <zirain2009@gmail.com> * nits Signed-off-by: zirain <zirain2009@gmail.com> --------- Signed-off-by: zirain <zirain2009@gmail.com>
guydc · Jan 31, 2024 · 3e99199 · 3e99199
1 parent fb8d48c
commit 3e99199
Show file tree

Hide file tree

Showing 6 changed files with 127 additions and 108 deletions.
diff --git a/api/v1alpha1/securitypolicy_types.go b/api/v1alpha1/securitypolicy_types.go
@@ -44,7 +44,6 @@ type SecurityPolicySpec struct {
 	// is being attached to.
 	// This Policy and the TargetRef MUST be in the same namespace
 	// for this Policy to have effect and be applied to the Gateway.
-	// TargetRef
 	TargetRef gwapiv1a2.PolicyTargetReferenceWithSectionName `json:"targetRef"`
 
 	// CORS defines the configuration for Cross-Origin Resource Sharing (CORS).

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_securitypolicies.yaml
@@ -488,7 +488,7 @@ spec:
                 description: TargetRef is the name of the Gateway resource this policy
                   is being attached to. This Policy and the TargetRef MUST be in the
                   same namespace for this Policy to have effect and be applied to
-                  the Gateway. TargetRef
+                  the Gateway.
                 properties:
                   group:
                     description: Group is the group of the target resource.