Add listType annotations to prevent some OpenAPI rules violations

This is part of #1271 - `names_match` violations still need to be dealt with. Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
tektoncd · Jan 20, 2022 · 91a821e · 91a821e
1 parent 7fbff3b
commit 91a821e
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 28 deletions.
diff --git a/pkg/apis/triggers/v1alpha1/event_listener_types.go b/pkg/apis/triggers/v1alpha1/event_listener_types.go
@@ -58,11 +58,12 @@ var _ kmeta.OwnerRefable = (*EventListener)(nil)
 // EventListenerSpec defines the desired state of the EventListener, represented
 // by a list of Triggers.
 type EventListenerSpec struct {
-	ServiceAccountName string                 `json:"serviceAccountName,omitempty"`
-	Triggers           []EventListenerTrigger `json:"triggers"`
-	NamespaceSelector  NamespaceSelector      `json:"namespaceSelector,omitempty"`
-	LabelSelector      *metav1.LabelSelector  `json:"labelSelector,omitempty"`
-	Resources          Resources              `json:"resources,omitempty"`
+	ServiceAccountName string `json:"serviceAccountName,omitempty"`
+	// +listType=atomic
+	Triggers          []EventListenerTrigger `json:"triggers"`
+	NamespaceSelector NamespaceSelector      `json:"namespaceSelector,omitempty"`
+	LabelSelector     *metav1.LabelSelector  `json:"labelSelector,omitempty"`
+	Resources         Resources              `json:"resources,omitempty"`
 }
 
 type Resources struct {
@@ -85,11 +86,13 @@ type KubernetesResource struct {
 // TriggerTemplate to then create resources from. TriggerRef can also be
 // provided instead of TriggerBinding, Interceptors and TriggerTemplate
 type EventListenerTrigger struct {
+	// +listType=atomic
 	Bindings   []*EventListenerBinding `json:"bindings,omitempty"`
 	Template   *EventListenerTemplate  `json:"template,omitempty"`
 	TriggerRef string                  `json:"triggerRef,omitempty"`
 	// +optional
-	Name         string              `json:"name,omitempty"`
+	Name string `json:"name,omitempty"`
+	// +listType=atomic
 	Interceptors []*EventInterceptor `json:"interceptors,omitempty"`
 	// ServiceAccountName optionally associates credentials with each trigger;
 	// more granular authorization for
@@ -154,6 +157,7 @@ type EventListenerConfig struct {
 // +k8s:openapi-gen=true
 type NamespaceSelector struct {
 	// List of namespace names.
+	// +listType=atomic
 	MatchNames []string `json:"matchNames,omitempty"`
 }
 

diff --git a/pkg/apis/triggers/v1alpha1/trigger_binding_types.go b/pkg/apis/triggers/v1alpha1/trigger_binding_types.go
@@ -40,6 +40,7 @@ func (tb *TriggerBinding) Copy() TriggerBindingInterface {
 // TriggerBindingSpec defines the desired state of the TriggerBinding.
 type TriggerBindingSpec struct {
 	// Params defines the parameter mapping from the given input event.
+	// +listType=atomic
 	Params []Param `json:"params,omitempty"`
 }
 

diff --git a/pkg/apis/triggers/v1alpha1/trigger_template_types.go b/pkg/apis/triggers/v1alpha1/trigger_template_types.go
@@ -28,7 +28,9 @@ var _ apis.Defaultable = (*TriggerTemplate)(nil)
 
 // TriggerTemplateSpec holds the desired state of TriggerTemplate
 type TriggerTemplateSpec struct {
-	Params            []ParamSpec               `json:"params,omitempty"`
+	// +listType=atomic
+	Params []ParamSpec `json:"params,omitempty"`
+	// +listType=atomic
 	ResourceTemplates []TriggerResourceTemplate `json:"resourcetemplates,omitempty"`
 }
 

diff --git a/pkg/apis/triggers/v1alpha1/trigger_types.go b/pkg/apis/triggers/v1alpha1/trigger_types.go
@@ -31,10 +31,12 @@ import (
 // and TriggerSpecTemplate; TriggerSpecBinding provides extracted values for
 // TriggerSpecTemplate to then create resources from.
 type TriggerSpec struct {
+	// +listType=atomic
 	Bindings []*TriggerSpecBinding `json:"bindings"`
 	Template TriggerSpecTemplate   `json:"template"`
 	// +optional
-	Name         string                `json:"name,omitempty"`
+	Name string `json:"name,omitempty"`
+	// +listType=atomic
 	Interceptors []*TriggerInterceptor `json:"interceptors,omitempty"`
 	// ServiceAccountName optionally associates credentials with each trigger;
 	// Unlike EventListeners, this should be scoped to the same namespace
@@ -92,6 +94,7 @@ type TriggerInterceptor struct {
 	// Ref refers to the Interceptor to use
 	Ref InterceptorRef `json:"ref"`
 	// Params are the params to send to the interceptor
+	// +listType=atomic
 	Params []InterceptorParams `json:"params,omitempty"`
 
 	// WebhookInterceptor refers to an old style webhook interceptor service
@@ -239,30 +242,35 @@ type WebhookInterceptor struct {
 	// Header is a group of key-value pairs that can be appended to the
 	// interceptor request headers. This allows the interceptor to make
 	// decisions specific to an EventListenerTrigger.
+	// +listType=atomic
 	Header []v1beta1.Param `json:"header,omitempty"`
 }
 
 // BitbucketInterceptor provides a webhook to intercept and pre-process events
 type BitbucketInterceptor struct {
-	SecretRef  *SecretRef `json:"secretRef,omitempty"`
-	EventTypes []string   `json:"eventTypes,omitempty"`
+	SecretRef *SecretRef `json:"secretRef,omitempty"`
+	// +listType=atomic
+	EventTypes []string `json:"eventTypes,omitempty"`
 }
 
 // GitHubInterceptor provides a webhook to intercept and pre-process events
 type GitHubInterceptor struct {
-	SecretRef  *SecretRef `json:"secretRef,omitempty"`
-	EventTypes []string   `json:"eventTypes,omitempty"`
+	SecretRef *SecretRef `json:"secretRef,omitempty"`
+	// +listType=atomic
+	EventTypes []string `json:"eventTypes,omitempty"`
 }
 
 // GitLabInterceptor provides a webhook to intercept and pre-process events
 type GitLabInterceptor struct {
-	SecretRef  *SecretRef `json:"secretRef,omitempty"`
-	EventTypes []string   `json:"eventTypes,omitempty"`
+	SecretRef *SecretRef `json:"secretRef,omitempty"`
+	// +listType=atomic
+	EventTypes []string `json:"eventTypes,omitempty"`
 }
 
 // CELInterceptor provides a webhook to intercept and pre-process events
 type CELInterceptor struct {
-	Filter   string       `json:"filter,omitempty"`
+	Filter string `json:"filter,omitempty"`
+	// +listType=atomic
 	Overlays []CELOverlay `json:"overlays,omitempty"`
 }
 

diff --git a/pkg/apis/triggers/v1beta1/event_listener_types.go b/pkg/apis/triggers/v1beta1/event_listener_types.go
@@ -57,9 +57,11 @@ var _ kmeta.OwnerRefable = (*EventListener)(nil)
 // EventListenerSpec defines the desired state of the EventListener, represented
 // by a list of Triggers.
 type EventListenerSpec struct {
-	ServiceAccountName string                 `json:"serviceAccountName,omitempty"`
-	Triggers           []EventListenerTrigger `json:"triggers,omitempty"`
+	ServiceAccountName string `json:"serviceAccountName,omitempty"`
+	// +listType=atomic
+	Triggers []EventListenerTrigger `json:"triggers,omitempty"`
 	// Trigger groups allow for centralized processing of an interceptor chain
+	// +listType=atomic
 	TriggerGroups     []EventListenerTriggerGroup `json:"triggerGroups,omitempty"`
 	NamespaceSelector NamespaceSelector           `json:"namespaceSelector,omitempty"`
 	LabelSelector     *metav1.LabelSelector       `json:"labelSelector,omitempty"`
@@ -84,6 +86,7 @@ type KubernetesResource struct {
 type PodTemplate struct {
 	// If specified, the pod's tolerations.
 	// +optional
+	// +listType=atomic
 	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
 
 	// NodeSelector is a selector which must be true for the pod to fit on a node.
@@ -98,11 +101,13 @@ type PodTemplate struct {
 // TriggerTemplate to then create resources from. TriggerRef can also be
 // provided instead of TriggerBinding, Interceptors and TriggerTemplate
 type EventListenerTrigger struct {
+	// +listType=atomic
 	Bindings   []*EventListenerBinding `json:"bindings,omitempty"`
 	Template   *EventListenerTemplate  `json:"template,omitempty"`
 	TriggerRef string                  `json:"triggerRef,omitempty"`
 	// +optional
-	Name         string              `json:"name,omitempty"`
+	Name string `json:"name,omitempty"`
+	// +listType=atomic
 	Interceptors []*EventInterceptor `json:"interceptors,omitempty"`
 	// ServiceAccountName optionally associates credentials with each trigger;
 	// more granular authorization for
@@ -116,7 +121,8 @@ type EventListenerTrigger struct {
 
 // EventListenerTriggerGroup defines a group of Triggers that share a common set of interceptors
 type EventListenerTriggerGroup struct {
-	Name            string                       `json:"name"`
+	Name string `json:"name"`
+	// +listType=atomic
 	Interceptors    []*TriggerInterceptor        `json:"interceptors"`
 	TriggerSelector EventListenerTriggerSelector `json:"triggerSelector"`
 }
@@ -180,6 +186,7 @@ type EventListenerConfig struct {
 // +k8s:openapi-gen=true
 type NamespaceSelector struct {
 	// List of namespace names.
+	// +listType=atomic
 	MatchNames []string `json:"matchNames,omitempty"`
 }
 

diff --git a/pkg/apis/triggers/v1beta1/trigger_binding_types.go b/pkg/apis/triggers/v1beta1/trigger_binding_types.go
@@ -40,6 +40,7 @@ func (tb *TriggerBinding) Copy() TriggerBindingInterface {
 // TriggerBindingSpec defines the desired state of the TriggerBinding.
 type TriggerBindingSpec struct {
 	// Params defines the parameter mapping from the given input event.
+	// +listType=atomic
 	Params []Param `json:"params,omitempty"`
 }
 

diff --git a/pkg/apis/triggers/v1beta1/trigger_template_types.go b/pkg/apis/triggers/v1beta1/trigger_template_types.go
@@ -28,7 +28,9 @@ var _ apis.Defaultable = (*TriggerTemplate)(nil)
 
 // TriggerTemplateSpec holds the desired state of TriggerTemplate
 type TriggerTemplateSpec struct {
-	Params            []ParamSpec               `json:"params,omitempty"`
+	// +listType=atomic
+	Params []ParamSpec `json:"params,omitempty"`
+	// +listType=atomic
 	ResourceTemplates []TriggerResourceTemplate `json:"resourcetemplates,omitempty"`
 }
 

diff --git a/pkg/apis/triggers/v1beta1/trigger_types.go b/pkg/apis/triggers/v1beta1/trigger_types.go
@@ -28,10 +28,12 @@ import (
 // and TriggerSpecTemplate; TriggerSpecBinding provides extracted values for
 // TriggerSpecTemplate to then create resources from.
 type TriggerSpec struct {
+	// +listType=atomic
 	Bindings []*TriggerSpecBinding `json:"bindings"`
 	Template TriggerSpecTemplate   `json:"template"`
 	// +optional
-	Name         string                `json:"name,omitempty"`
+	Name string `json:"name,omitempty"`
+	// +listType=atomic
 	Interceptors []*TriggerInterceptor `json:"interceptors,omitempty"`
 	// ServiceAccountName optionally associates credentials with each trigger;
 	// Unlike EventListeners, this should be scoped to the same namespace
@@ -89,6 +91,7 @@ type TriggerInterceptor struct {
 	// Ref refers to the Interceptor to use
 	Ref InterceptorRef `json:"ref"`
 	// Params are the params to send to the interceptor
+	// +listType=atomic
 	Params []InterceptorParams `json:"params,omitempty"`
 
 	// WebhookInterceptor refers to an old style webhook interceptor service
@@ -148,30 +151,35 @@ type WebhookInterceptor struct {
 	// Header is a group of key-value pairs that can be appended to the
 	// interceptor request headers. This allows the interceptor to make
 	// decisions specific to an EventListenerTrigger.
+	// +listType=atomic
 	Header []v1beta1.Param `json:"header,omitempty"`
 }
 
 // BitbucketInterceptor provides a webhook to intercept and pre-process events
 type BitbucketInterceptor struct {
-	SecretRef  *SecretRef `json:"secretRef,omitempty"`
-	EventTypes []string   `json:"eventTypes,omitempty"`
+	SecretRef *SecretRef `json:"secretRef,omitempty"`
+	// +listType=atomic
+	EventTypes []string `json:"eventTypes,omitempty"`
 }
 
 // GitHubInterceptor provides a webhook to intercept and pre-process events
 type GitHubInterceptor struct {
-	SecretRef  *SecretRef `json:"secretRef,omitempty"`
-	EventTypes []string   `json:"eventTypes,omitempty"`
+	SecretRef *SecretRef `json:"secretRef,omitempty"`
+	// +listType=atomic
+	EventTypes []string `json:"eventTypes,omitempty"`
 }
 
 // GitLabInterceptor provides a webhook to intercept and pre-process events
 type GitLabInterceptor struct {
-	SecretRef  *SecretRef `json:"secretRef,omitempty"`
-	EventTypes []string   `json:"eventTypes,omitempty"`
+	SecretRef *SecretRef `json:"secretRef,omitempty"`
+	// +listType=atomic
+	EventTypes []string `json:"eventTypes,omitempty"`
 }
 
 // CELInterceptor provides a webhook to intercept and pre-process events
 type CELInterceptor struct {
-	Filter   string       `json:"filter,omitempty"`
+	Filter string `json:"filter,omitempty"`
+	// +listType=atomic
 	Overlays []CELOverlay `json:"overlays,omitempty"`
 }