From 51fb9c6decd672a4867e0cacf3ccf38a25d8db35 Mon Sep 17 00:00:00 2001 From: Khurram Baig Date: Fri, 3 May 2024 15:39:49 +0530 Subject: [PATCH] Fix API doc by adding TriggerTemplate to Resource Types --- docs/triggers-api.md | 382 ++++++++++-------- .../v1alpha1/trigger_template_types.go | 4 +- .../v1beta1/trigger_template_types.go | 3 +- 3 files changed, 214 insertions(+), 175 deletions(-) diff --git a/docs/triggers-api.md b/docs/triggers-api.md index 56cdfedd1..ccc7f532b 100644 --- a/docs/triggers-api.md +++ b/docs/triggers-api.md @@ -28,6 +28,8 @@ Resource Types: Trigger
  • TriggerBinding +
  • +TriggerTemplate

    • ClusterTriggerBinding

    @@ -479,6 +481,108 @@ TriggerBindingStatus +

    TriggerTemplate +

    +
    +

    TriggerTemplate takes parameters and uses them to create CRDs

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +apiVersion
    +string    		 + +triggers.tekton.dev/v1alpha1 + +
    +kind
    +string +    		TriggerTemplate
    +metadata
    + + +Kubernetes meta/v1.ObjectMeta + + +    		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
    +spec
    + + +TriggerTemplateSpec + + +    		 +(Optional) +

    Spec holds the desired state of the TriggerTemplate from the client

    +
    +
    + + + + + + + + + +
    +params
    + + +[]ParamSpec + + +    		 +
    +resourcetemplates
    + + +[]TriggerResourceTemplate + + +    		 +
    +
    +status
    + + +TriggerTemplateStatus + + +    		 +(Optional) +

    BitbucketInterceptor

    @@ -2460,95 +2564,10 @@ TriggerTemplateSpec -

    TriggerTemplate -

    -
    -

    TriggerTemplate takes parameters and uses them to create CRDs

    -
    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -TriggerTemplateSpec - - -    		 -(Optional) -

    Spec holds the desired state of the TriggerTemplate from the client

    -
    -
    - - - - - - - - - -
    -params
    - - -[]ParamSpec - - -    		 -
    -resourcetemplates
    - - -[]TriggerResourceTemplate - - -    		 -
    -
    -status
    - - -TriggerTemplateStatus - - -    		 -(Optional) -

    TriggerTemplateSpec

    -(Appears on:TriggerSpecTemplate, TriggerTemplate) +(Appears on:TriggerTemplate, TriggerSpecTemplate)

    TriggerTemplateSpec holds the desired state of TriggerTemplate

    @@ -2670,6 +2689,8 @@ Resource Types: Trigger
  • TriggerBinding +
  • +TriggerTemplate

    • ClusterTriggerBinding

    @@ -3144,6 +3165,108 @@ TriggerBindingStatus +

    TriggerTemplate +

    +
    +

    TriggerTemplate takes parameters and uses them to create CRDs

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +apiVersion
    +string    		 + +triggers.tekton.dev/v1beta1 + +
    +kind
    +string +    		TriggerTemplate
    +metadata
    + + +Kubernetes meta/v1.ObjectMeta + + +    		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
    +spec
    + + +TriggerTemplateSpec + + +    		 +(Optional) +

    Spec holds the desired state of the TriggerTemplate from the client

    +
    +
    + + + + + + + + + +
    +params
    + + +[]ParamSpec + + +    		 +
    +resourcetemplates
    + + +[]TriggerResourceTemplate + + +    		 +
    +
    +status
    + + +TriggerTemplateStatus + + +    		 +(Optional) +

    CustomResource

    @@ -4577,95 +4700,10 @@ TriggerTemplateSpec -

    TriggerTemplate -

    -
    -

    TriggerTemplate takes parameters and uses them to create CRDs

    -
    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -TriggerTemplateSpec - - -    		 -(Optional) -

    Spec holds the desired state of the TriggerTemplate from the client

    -
    -
    - - - - - - - - - -
    -params
    - - -[]ParamSpec - - -    		 -
    -resourcetemplates
    - - -[]TriggerResourceTemplate - - -    		 -
    -
    -status
    - - -TriggerTemplateStatus - - -    		 -(Optional) -

    TriggerTemplateSpec

    -(Appears on:TriggerSpecTemplate, TriggerTemplate) +(Appears on:TriggerTemplate, TriggerSpecTemplate)

    TriggerTemplateSpec holds the desired state of TriggerTemplate

    diff --git a/pkg/apis/triggers/v1alpha1/trigger_template_types.go b/pkg/apis/triggers/v1alpha1/trigger_template_types.go index 0a5fa6113..a8e5cb631 100644 --- a/pkg/apis/triggers/v1alpha1/trigger_template_types.go +++ b/pkg/apis/triggers/v1alpha1/trigger_template_types.go @@ -42,10 +42,10 @@ type TriggerResourceTemplate struct { // TriggerTemplateStatus describes the desired state of TriggerTemplate type TriggerTemplateStatus struct{} -// TriggerTemplate takes parameters and uses them to create CRDs -// // +genclient // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object + +// TriggerTemplate takes parameters and uses them to create CRDs // +k8s:openapi-gen=true type TriggerTemplate struct { metav1.TypeMeta `json:",inline"` diff --git a/pkg/apis/triggers/v1beta1/trigger_template_types.go b/pkg/apis/triggers/v1beta1/trigger_template_types.go index 78689cdb8..9fedae829 100644 --- a/pkg/apis/triggers/v1beta1/trigger_template_types.go +++ b/pkg/apis/triggers/v1beta1/trigger_template_types.go @@ -42,10 +42,11 @@ type TriggerResourceTemplate struct { // TriggerTemplateStatus describes the desired state of TriggerTemplate type TriggerTemplateStatus struct{} -// TriggerTemplate takes parameters and uses them to create CRDs // // +genclient // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object + +// TriggerTemplate takes parameters and uses them to create CRDs // +k8s:openapi-gen=true type TriggerTemplate struct { metav1.TypeMeta `json:",inline"`