From a98eb2eeb3354f6a476ea98be7147108dcf24a87 Mon Sep 17 00:00:00 2001 From: Paul Morie Date: Tue, 28 May 2019 15:13:16 -0400 Subject: [PATCH] Add type godoc for Broker and Trigger --- pkg/apis/eventing/v1alpha1/broker_types.go | 5 +++++ pkg/apis/eventing/v1alpha1/trigger_types.go | 2 ++ 2 files changed, 7 insertions(+) diff --git a/pkg/apis/eventing/v1alpha1/broker_types.go b/pkg/apis/eventing/v1alpha1/broker_types.go index 27d2448bc56..99645e7ebbd 100644 --- a/pkg/apis/eventing/v1alpha1/broker_types.go +++ b/pkg/apis/eventing/v1alpha1/broker_types.go @@ -29,6 +29,11 @@ import ( // +genclient // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +// Broker collects a pool of events that are consumable using Triggers. Brokers +// provide a well-known endpoint for event delivery that senders can use with +// minimal knowledge of the event routing strategy. Receivers use Triggers to +// request delivery of events from a Broker's pool to a specific URL or +// Addressable endpoint. type Broker struct { metav1.TypeMeta `json:",inline"` // +optional diff --git a/pkg/apis/eventing/v1alpha1/trigger_types.go b/pkg/apis/eventing/v1alpha1/trigger_types.go index e2d4e927a10..73fa9cc05c9 100644 --- a/pkg/apis/eventing/v1alpha1/trigger_types.go +++ b/pkg/apis/eventing/v1alpha1/trigger_types.go @@ -29,6 +29,8 @@ import ( // +genclient // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +// Trigger represents a request to have events delivered to a consumer from a +// Broker's event pool. type Trigger struct { metav1.TypeMeta `json:",inline"` // +optional