Skip to content

Commit

Permalink
Fix Alert .spec.eventMetadata documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
  • Loading branch information
matheuscscp committed Jun 2, 2023
1 parent 94cd2a6 commit 168d190
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion api/v1beta2/alert_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/api/v1beta2/notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion docs/spec/v1beta2/alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 168d190

Please sign in to comment.