Merge pull request #541 from matheuscscp/fix-metadata-docs

Fix Alert .spec.eventMetadata documentation
fluxcd · Jun 5, 2023 · 56a77b7 · 56a77b7
2 parents 6af6b15 + 4c1978b
commit 56a77b7
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/api/v1beta2/alert_types.go b/api/v1beta2/alert_types.go
@@ -53,7 +53,7 @@ type AlertSpec struct {
 	// EventMetadata is an optional field for adding metadata to events dispatched by the
 	// controller. This can be used for enhancing the context of the event. If a field
 	// would override one already present on the original event as generated by the emitter,
-	// then the override doesn't happen, i.e. the original value is preserved, and an error
+	// then the override doesn't happen, i.e. the original value is preserved, and an info
 	// log is printed.
 	// +optional
 	EventMetadata map[string]string `json:"eventMetadata,omitempty"`

diff --git a/config/crd/bases/notification.toolkit.fluxcd.io_alerts.yaml b/config/crd/bases/notification.toolkit.fluxcd.io_alerts.yaml
@@ -247,7 +247,7 @@ spec:
                   the context of the event. If a field would override one already
                   present on the original event as generated by the emitter, then
                   the override doesn't happen, i.e. the original value is preserved,
-                  and an error log is printed.
+                  and an info log is printed.
                 type: object
               eventSeverity:
                 default: info

diff --git a/docs/api/v1beta2/notification.md b/docs/api/v1beta2/notification.md
@@ -137,7 +137,7 @@ map[string]string
 <p>EventMetadata is an optional field for adding metadata to events dispatched by the
 controller. This can be used for enhancing the context of the event. If a field
 would override one already present on the original event as generated by the emitter,
-then the override doesn&rsquo;t happen, i.e. the original value is preserved, and an error
+then the override doesn&rsquo;t happen, i.e. the original value is preserved, and an info
 log is printed.</p>
 </td>
 </tr>
@@ -641,7 +641,7 @@ map[string]string
 <p>EventMetadata is an optional field for adding metadata to events dispatched by the
 controller. This can be used for enhancing the context of the event. If a field
 would override one already present on the original event as generated by the emitter,
-then the override doesn&rsquo;t happen, i.e. the original value is preserved, and an error
+then the override doesn&rsquo;t happen, i.e. the original value is preserved, and an info
 log is printed.</p>
 </td>
 </tr>

diff --git a/docs/spec/v1beta2/alerts.md b/docs/spec/v1beta2/alerts.md
@@ -167,7 +167,7 @@ preventing tenants from subscribing to another tenant's events.
 `.spec.eventMetadata` is an optional field for adding metadata to events dispatched by
 the controller. This can be used for enhancing the context of the event. If a field
 would override one already present on the original event as generated by the emitter,
-then the override doesn't happen, i.e. the original value is preserved, and an error
+then the override doesn't happen, i.e. the original value is preserved, and an info
 log is printed.
 
 #### Example