Skip to content

[WIP] Add descriptions for Trigger. #3573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vaikas wants to merge 1 commit into from
Closed

[WIP] Add descriptions for Trigger. #3573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 30 additions & 10 deletions config/core/resources/trigger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,26 +47,29 @@ spec:
schema:
openAPIV3Schema:
type: object
description: "This is a trigger description."
properties:
spec:
required:
- subscriber
type: object
description: "The specification for the trigger"
properties:
broker:
type: string
description: "Broker that this trigger receives events from. If not specified, will default to 'default'."
filter:
description: "Optional 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."
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. Each key in the map is compared with the equivalent key in the event context. An event passes the filter if all values are equal to the specified values."
additionalProperties:
type: string
subscriber:
type: object
description: "the destination that should receive events."
description: "Subscriber is the addressable that receives events from the Broker that pass the filter."
properties:
ref:
type: object
Expand All @@ -90,42 +93,52 @@ 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 full 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
description: "Status of the trigger"
properties:
subscriberUri:
type: string
description: "SubscriberURI is the resolved URI of the receiver for this Trigger."
observedGeneration:
type: integer
description: "ObservedGeneration is the 'Generation' of the Trigger that was last processed by the controller."
- << : *version
name: v1
served: true
storage: false
schema:
openAPIV3Schema:
type: object
description: "This is a trigger description."
properties:
spec:
required:
- subscriber
- broker
- subscriber
type: object
description: "The specification for the trigger"
properties:
broker:
type: string
description: "Broker that this trigger receives events from."
filter:
description: "Optional 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."
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. Each key in the map is compared with the equivalent key in the event context. An event passes the filter if all values are equal to the specified values."
additionalProperties:
type: string
subscriber:
type: object
description: "the destination that should receive events."
description: "Subscriber is the addressable that receives events from the Broker that pass the filter. You can use one or both of ref/uri to specify the "
properties:
ref:
type: object
description: "a reference to a Kubernetes object from which to retrieve the target URI."
description: "Reference to a Kubernetes object (addressable) from which to retrieve the target URI."
required:
- apiVersion
- kind
Expand All @@ -145,10 +158,17 @@ 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 full 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
description: "status of the trigger"
properties:
subscriberUri:
type: string
description: "SubscriberURI is the resolved URI of the receiver for this Trigger."
observedGeneration:
type: integer
description: "ObservedGeneration is the 'Generation' of the Trigger that was last processed by the controller."
names:
kind: Trigger
plural: triggers
Expand Down
5 changes: 2 additions & 3 deletions pkg/apis/eventing/v1/trigger_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,8 @@ var (
)

type TriggerSpec struct {
// Broker is the broker that this trigger receives events from. If not specified, will default
// to 'default'.
Broker string `json:"broker,omitempty"`
// Broker is the broker that this trigger receives events from.
Broker string `json:"broker"`

// 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.
Expand Down