Improve the API documentation.

fluxcd · Nov 1, 2024 · 8a9e435 · 8a9e435
1 parent 18c1f31
commit 8a9e435
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/api/v1/receiver_types.go b/api/v1/receiver_types.go
@@ -67,9 +67,9 @@ type ReceiverSpec struct {
 	// +required
 	Resources []CrossNamespaceObjectReference `json:"resources"`
 
-	// ResourceFilter is an expression that is applied to each Resource
+	// ResourceFilter is a CEL expression that is applied to each Resource
 	// referenced in the Resources. If the expression returns false then the
-	// Resource is discarded and will not be notified.
+	// Resource will not be notified.
 	ResourceFilter string `json:"resourceFilter,omitempty"`
 
 	// SecretRef specifies the Secret containing the token used

diff --git a/config/crd/bases/notification.toolkit.fluxcd.io_receivers.yaml b/config/crd/bases/notification.toolkit.fluxcd.io_receivers.yaml
@@ -64,9 +64,9 @@ spec:
                 type: string
               resourceFilter:
                 description: |-
-                  ResourceFilter is an expression that is applied to each Resource
+                  ResourceFilter is a CEL expression that is applied to each Resource
                   referenced in the Resources. If the expression returns false then the
-                  Resource is discarded and will not be notified.
+                  Resource will not be notified.
                 type: string
               resources:
                 description: A list of resources to be notified about changes.

diff --git a/docs/api/v1/notification.md b/docs/api/v1/notification.md
@@ -128,9 +128,9 @@ string
 </em>
 </td>
 <td>
-<p>ResourceFilter is an expression that is applied to each Resource
+<p>ResourceFilter is a CEL expression that is applied to each Resource
 referenced in the Resources. If the expression returns false then the
-Resource is discarded and will not be notified.</p>
+Resource will not be notified.</p>
 </td>
 </tr>
 <tr>
@@ -340,9 +340,9 @@ string
 </em>
 </td>
 <td>
-<p>ResourceFilter is an expression that is applied to each Resource
+<p>ResourceFilter is a CEL expression that is applied to each Resource
 referenced in the Resources. If the expression returns false then the
-Resource is discarded and will not be notified.</p>
+Resource will not be notified.</p>
 </td>
 </tr>
 <tr>