diff --git a/config/core/resources/trigger.yaml b/config/core/resources/trigger.yaml index e77984dd533..ab6acd0f547 100644 --- a/config/core/resources/trigger.yaml +++ b/config/core/resources/trigger.yaml @@ -55,22 +55,22 @@ spec: properties: broker: type: string - description: "Broker that this trigger receives events from. If not specified, will default to 'default'." + description: 'Broker that this trigger receives events from. If not specified, will default to ''default''.' filter: type: object properties: attributes: type: object - description: "Map of CloudEvents attributes used for filtering events. If not specified, will default to all events" + description: 'Map of CloudEvents attributes used for filtering events. If not specified, will default to all events' additionalProperties: type: string subscriber: type: object - description: "the destination that should receive events." + description: 'the destination that should receive events.' properties: ref: type: object - description: "a reference to a Kubernetes object from which to retrieve the target URI." + description: 'a reference to a Kubernetes object from which to retrieve the target URI.' required: - apiVersion - kind @@ -90,7 +90,7 @@ spec: minLength: 1 uri: type: string - description: "the target URI or, if ref is provided, a relative URI reference that will be combined with ref to produce a target URI." + description: 'the target URI or, if ref is provided, a relative URI reference that will be combined with ref to produce a target URI.' status: type: object x-kubernetes-preserve-unknown-fields: true @@ -101,8 +101,10 @@ spec: schema: openAPIV3Schema: type: object + description: 'Trigger represents a request to have events delivered to a subscriber from a Broker''s event pool.' properties: spec: + description: 'Spec defines the desired state of the Trigger.' required: - subscriber - broker @@ -110,22 +112,26 @@ spec: properties: broker: type: string - description: "Broker that this trigger receives events from." + description: 'Broker that this trigger receives events from.' filter: type: object + description: 'Filter is the filter to apply against all events from + the Broker. Only events that pass this filter will be sent to + the Subscriber. If not specified, will default to allowing all + events.' properties: attributes: type: object - description: "Map of CloudEvents attributes used for filtering events. If not specified, will default to all events" + description: 'Map of CloudEvents attributes used for filtering events. If not specified, will default to all events' additionalProperties: type: string subscriber: type: object - description: "the destination that should receive events." + description: 'the destination that should receive events.' properties: ref: type: object - description: "a reference to a Kubernetes object from which to retrieve the target URI." + description: 'a reference to a Kubernetes object from which to retrieve the target URI.' required: - apiVersion - kind @@ -145,8 +151,9 @@ spec: minLength: 1 uri: type: string - description: "the target URI or, if ref is provided, a relative URI reference that will be combined with ref to produce a target URI." + description: 'the target URI or, if ref is provided, a relative URI reference that will be combined with ref to produce a target URI.' status: + description: 'Status represents the current state of the Trigger. This data may be out of date.' type: object x-kubernetes-preserve-unknown-fields: true names: diff --git a/pkg/apis/eventing/v1/broker_types.go b/pkg/apis/eventing/v1/broker_types.go index 7771fc866a6..53e1c7808bd 100644 --- a/pkg/apis/eventing/v1/broker_types.go +++ b/pkg/apis/eventing/v1/broker_types.go @@ -33,7 +33,7 @@ import ( // 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 +// minimal knowledge of the event routing strategy. Subscribers use Triggers to // request delivery of events from a Broker's pool to a specific URL or // Addressable endpoint. type Broker struct { diff --git a/pkg/apis/eventing/v1/trigger_types.go b/pkg/apis/eventing/v1/trigger_types.go index db53dcf3c5c..c401388e766 100644 --- a/pkg/apis/eventing/v1/trigger_types.go +++ b/pkg/apis/eventing/v1/trigger_types.go @@ -41,7 +41,7 @@ const ( // +genreconciler // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// Trigger represents a request to have events delivered to a consumer from a +// Trigger represents a request to have events delivered to a subscriber from a // Broker's event pool. type Trigger struct { metav1.TypeMeta `json:",inline"` @@ -75,8 +75,7 @@ var ( ) type TriggerSpec struct { - // Broker is the broker that this trigger receives events from. If not specified, will default - // to 'default'. + // Broker is the broker that this trigger receives events from. Broker string `json:"broker,omitempty"` // Filter is the filter to apply against all events from the Broker. Only events that pass this