From 4af2f7d37f43cf86e676903b06cb721a9f1a60e9 Mon Sep 17 00:00:00 2001 From: David Eads Date: Tue, 27 Oct 2020 14:06:15 -0400 Subject: [PATCH] add godoc for events to events.k8s.io --- staging/src/k8s.io/api/events/v1/types.go | 5 +++++ staging/src/k8s.io/api/events/v1beta1/types.go | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/staging/src/k8s.io/api/events/v1/types.go b/staging/src/k8s.io/api/events/v1/types.go index f11c2799803..4bf715872ab 100644 --- a/staging/src/k8s.io/api/events/v1/types.go +++ b/staging/src/k8s.io/api/events/v1/types.go @@ -25,6 +25,11 @@ import ( // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object // Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. +// Events have a limited retention time and triggers and messages may evolve +// with time. Event consumers should not rely on the timing of an event +// with a given Reason reflecting a consistent underlying trigger, or the +// continued existence of events with that Reason. Events should be +// treated as informative, best-effort, supplemental data. type Event struct { metav1.TypeMeta `json:",inline"` diff --git a/staging/src/k8s.io/api/events/v1beta1/types.go b/staging/src/k8s.io/api/events/v1beta1/types.go index dce4e21dfd0..796e56ea7da 100644 --- a/staging/src/k8s.io/api/events/v1beta1/types.go +++ b/staging/src/k8s.io/api/events/v1beta1/types.go @@ -27,6 +27,11 @@ import ( // +k8s:prerelease-lifecycle-gen:deprecated=1.22 // Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. +// Events have a limited retention time and triggers and messages may evolve +// with time. Event consumers should not rely on the timing of an event +// with a given Reason reflecting a consistent underlying trigger, or the +// continued existence of events with that Reason. Events should be +// treated as informative, best-effort, supplemental data. type Event struct { metav1.TypeMeta `json:",inline"`