From 3cf1bfc67a177ef95bb17516181f842849aad6ce Mon Sep 17 00:00:00 2001 From: Matheus Pimenta Date: Fri, 2 Jun 2023 17:41:41 +0100 Subject: [PATCH] Fix Alert .spec.eventMetadata documentation --- api/v1beta2/alert_types.go | 2 +- config/crd/bases/notification.toolkit.fluxcd.io_alerts.yaml | 2 +- docs/api/v1beta2/notification.md | 4 ++-- docs/spec/v1beta2/alerts.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/api/v1beta2/alert_types.go b/api/v1beta2/alert_types.go index f1ea5a105..f39855acf 100644 --- 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 index a899e18dd..9a97d35d7 100644 --- 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 index e48ac49a7..66e135916 100644 --- a/docs/api/v1beta2/notification.md +++ b/docs/api/v1beta2/notification.md @@ -137,7 +137,7 @@ map[string]string

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.

@@ -641,7 +641,7 @@ map[string]string

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.

diff --git a/docs/spec/v1beta2/alerts.md b/docs/spec/v1beta2/alerts.md index b03ab4d17..804779877 100644 --- 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