From 38c098d25b1a0826920a8a19b349182d0b80d832 Mon Sep 17 00:00:00 2001 From: nanjingfm Date: Wed, 8 Mar 2023 22:18:37 +0800 Subject: [PATCH] chore: generate docs for new fields --- docs/pipeline-api.md | 169 ++++++++++++++++++ pkg/apis/pipeline/v1/openapi_generated.go | 35 ++++ pkg/apis/pipeline/v1/swagger.json | 20 +++ .../pipeline/v1beta1/openapi_generated.go | 35 ++++ pkg/apis/pipeline/v1beta1/swagger.json | 20 +++ 5 files changed, 279 insertions(+) diff --git a/docs/pipeline-api.md b/docs/pipeline-api.md index 41fa555253c..6ecdeb7f1ea 100644 --- a/docs/pipeline-api.md +++ b/docs/pipeline-api.md @@ -533,6 +533,19 @@ PipelineSpec + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+displayName
+ +string + +		 +(Optional) +

DisplayName is a user-facing name of the pipeline that may be +used to populate a UI.

+
description
string @@ -895,6 +908,19 @@ value.

+displayName
+ +string + +		 +(Optional) +

DisplayName is a user-facing name of the task that may be +used to populate a UI.

+
description
string @@ -2492,6 +2518,19 @@ TaskRunStatus
+displayName
+ +string + +		 +(Optional) +

DisplayName is a user-facing name of the pipeline that may be +used to populate a UI.

+
description
string @@ -2608,6 +2647,32 @@ the execution order of tasks relative to one another.

+displayName
+ +string + +		 +(Optional) +

DisplayName is the display name of this task within the context of a Pipeline. +This display name may be used to populate a UI.

+
+description
+ +string + +		 +(Optional) +

Description is the description of this task within the context of a Pipeline. +This description may be used to populate a UI.

+
taskRef
@@ -5310,6 +5375,19 @@ value.

+displayName
+ +string + +		 +(Optional) +

DisplayName is a user-facing name of the task that may be +used to populate a UI.

+
description
string @@ -6934,6 +7012,19 @@ value.

+displayName
+ +string + +		 +(Optional) +

DisplayName is a user-facing name of the task that may be +used to populate a UI.

+
description
string @@ -7292,6 +7383,19 @@ PipelineSpec + + + + + + + + + + + + + + + + + + + + + + + +
+displayName
+ +string + +		 +(Optional) +

DisplayName is a user-facing name of the pipeline that may be +used to populate a UI.

+
description
string @@ -7681,6 +7785,19 @@ value.

+displayName
+ +string + +		 +(Optional) +

DisplayName is a user-facing name of the task that may be +used to populate a UI.

+
description
string @@ -9699,6 +9816,19 @@ TaskRunStatus
+displayName
+ +string + +		 +(Optional) +

DisplayName is a user-facing name of the pipeline that may be +used to populate a UI.

+
description
string @@ -9815,6 +9945,32 @@ the execution order of tasks relative to one another.

+displayName
+ +string + +		 +(Optional) +

DisplayName is the display name of this task within the context of a Pipeline. +This display name may be used to populate a UI.

+
+description
+ +string + +		 +(Optional) +

Description is the description of this task within the context of a Pipeline. +This description may be used to populate a UI.

+
taskRef
@@ -12746,6 +12902,19 @@ value.

+displayName
+ +string + +		 +(Optional) +

DisplayName is a user-facing name of the task that may be +used to populate a UI.

+
description
string diff --git a/pkg/apis/pipeline/v1/openapi_generated.go b/pkg/apis/pipeline/v1/openapi_generated.go index 62a5fcd92ec..88f1582c1e4 100644 --- a/pkg/apis/pipeline/v1/openapi_generated.go +++ b/pkg/apis/pipeline/v1/openapi_generated.go @@ -534,6 +534,13 @@ func schema_pkg_apis_pipeline_v1_EmbeddedTask(ref common.ReferenceCallback) comm }, }, }, + "displayName": { + SchemaProps: spec.SchemaProps{ + Description: "DisplayName is a user-facing name of the task that may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, "description": { SchemaProps: spec.SchemaProps{ Description: "Description is a user-facing description of the task that may be used to populate a UI.", @@ -1667,6 +1674,13 @@ func schema_pkg_apis_pipeline_v1_PipelineSpec(ref common.ReferenceCallback) comm Description: "PipelineSpec defines the desired state of Pipeline.", Type: []string{"object"}, Properties: map[string]spec.Schema{ + "displayName": { + SchemaProps: spec.SchemaProps{ + Description: "DisplayName is a user-facing name of the pipeline that may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, "description": { SchemaProps: spec.SchemaProps{ Description: "Description is a user-facing description of the pipeline that may be used to populate a UI.", @@ -1791,6 +1805,20 @@ func schema_pkg_apis_pipeline_v1_PipelineTask(ref common.ReferenceCallback) comm Format: "", }, }, + "displayName": { + SchemaProps: spec.SchemaProps{ + Description: "DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, + "description": { + SchemaProps: spec.SchemaProps{ + Description: "Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, "taskRef": { SchemaProps: spec.SchemaProps{ Description: "TaskRef is a reference to a task definition.", @@ -4067,6 +4095,13 @@ func schema_pkg_apis_pipeline_v1_TaskSpec(ref common.ReferenceCallback) common.O }, }, }, + "displayName": { + SchemaProps: spec.SchemaProps{ + Description: "DisplayName is a user-facing name of the task that may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, "description": { SchemaProps: spec.SchemaProps{ Description: "Description is a user-facing description of the task that may be used to populate a UI.", diff --git a/pkg/apis/pipeline/v1/swagger.json b/pkg/apis/pipeline/v1/swagger.json index a08d40d8846..34ff5f759b2 100644 --- a/pkg/apis/pipeline/v1/swagger.json +++ b/pkg/apis/pipeline/v1/swagger.json @@ -213,6 +213,10 @@ "description": "Description is a user-facing description of the task that may be used to populate a UI.", "type": "string" }, + "displayName": { + "description": "DisplayName is a user-facing name of the task that may be used to populate a UI.", + "type": "string" + }, "kind": { "type": "string" }, @@ -832,6 +836,10 @@ "description": "Description is a user-facing description of the pipeline that may be used to populate a UI.", "type": "string" }, + "displayName": { + "description": "DisplayName is a user-facing name of the pipeline that may be used to populate a UI.", + "type": "string" + }, "finally": { "description": "Finally declares the list of Tasks that execute just before leaving the Pipeline i.e. either after all Tasks are finished executing successfully or after a failure which would result in ending the Pipeline", "type": "array", @@ -883,6 +891,14 @@ "description": "PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.", "type": "object", "properties": { + "description": { + "description": "Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.", + "type": "string" + }, + "displayName": { + "description": "DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.", + "type": "string" + }, "matrix": { "description": "Matrix declares parameters used to fan out this task.", "$ref": "#/definitions/v1.Matrix" @@ -2102,6 +2118,10 @@ "description": "Description is a user-facing description of the task that may be used to populate a UI.", "type": "string" }, + "displayName": { + "description": "DisplayName is a user-facing name of the task that may be used to populate a UI.", + "type": "string" + }, "params": { "description": "Params is a list of input parameters required to run the task. Params must be supplied as inputs in TaskRuns unless they declare a default value.", "type": "array", diff --git a/pkg/apis/pipeline/v1beta1/openapi_generated.go b/pkg/apis/pipeline/v1beta1/openapi_generated.go index 92bbcf4afd3..1e926fda074 100644 --- a/pkg/apis/pipeline/v1beta1/openapi_generated.go +++ b/pkg/apis/pipeline/v1beta1/openapi_generated.go @@ -943,6 +943,13 @@ func schema_pkg_apis_pipeline_v1beta1_EmbeddedTask(ref common.ReferenceCallback) }, }, }, + "displayName": { + SchemaProps: spec.SchemaProps{ + Description: "DisplayName is a user-facing name of the task that may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, "description": { SchemaProps: spec.SchemaProps{ Description: "Description is a user-facing description of the task that may be used to populate a UI.", @@ -2191,6 +2198,13 @@ func schema_pkg_apis_pipeline_v1beta1_PipelineSpec(ref common.ReferenceCallback) Description: "PipelineSpec defines the desired state of Pipeline.", Type: []string{"object"}, Properties: map[string]spec.Schema{ + "displayName": { + SchemaProps: spec.SchemaProps{ + Description: "DisplayName is a user-facing name of the pipeline that may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, "description": { SchemaProps: spec.SchemaProps{ Description: "Description is a user-facing description of the pipeline that may be used to populate a UI.", @@ -2315,6 +2329,20 @@ func schema_pkg_apis_pipeline_v1beta1_PipelineTask(ref common.ReferenceCallback) Format: "", }, }, + "displayName": { + SchemaProps: spec.SchemaProps{ + Description: "DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, + "description": { + SchemaProps: spec.SchemaProps{ + Description: "Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, "taskRef": { SchemaProps: spec.SchemaProps{ Description: "TaskRef is a reference to a task definition.", @@ -4792,6 +4820,13 @@ func schema_pkg_apis_pipeline_v1beta1_TaskSpec(ref common.ReferenceCallback) com }, }, }, + "displayName": { + SchemaProps: spec.SchemaProps{ + Description: "DisplayName is a user-facing name of the task that may be used to populate a UI.", + Type: []string{"string"}, + Format: "", + }, + }, "description": { SchemaProps: spec.SchemaProps{ Description: "Description is a user-facing description of the task that may be used to populate a UI.", diff --git a/pkg/apis/pipeline/v1beta1/swagger.json b/pkg/apis/pipeline/v1beta1/swagger.json index e8171739b5e..f2f3c9593e5 100644 --- a/pkg/apis/pipeline/v1beta1/swagger.json +++ b/pkg/apis/pipeline/v1beta1/swagger.json @@ -433,6 +433,10 @@ "description": "Description is a user-facing description of the task that may be used to populate a UI.", "type": "string" }, + "displayName": { + "description": "DisplayName is a user-facing name of the task that may be used to populate a UI.", + "type": "string" + }, "kind": { "type": "string" }, @@ -1116,6 +1120,10 @@ "description": "Description is a user-facing description of the pipeline that may be used to populate a UI.", "type": "string" }, + "displayName": { + "description": "DisplayName is a user-facing name of the pipeline that may be used to populate a UI.", + "type": "string" + }, "finally": { "description": "Finally declares the list of Tasks that execute just before leaving the Pipeline i.e. either after all Tasks are finished executing successfully or after a failure which would result in ending the Pipeline", "type": "array", @@ -1167,6 +1175,14 @@ "description": "PipelineTask defines a task in a Pipeline, passing inputs from both Params and from the output of previous tasks.", "type": "object", "properties": { + "description": { + "description": "Description is the description of this task within the context of a Pipeline. This description may be used to populate a UI.", + "type": "string" + }, + "displayName": { + "description": "DisplayName is the display name of this task within the context of a Pipeline. This display name may be used to populate a UI.", + "type": "string" + }, "matrix": { "description": "Matrix declares parameters used to fan out this task.", "$ref": "#/definitions/v1beta1.Matrix" @@ -2642,6 +2658,10 @@ "description": "Description is a user-facing description of the task that may be used to populate a UI.", "type": "string" }, + "displayName": { + "description": "DisplayName is a user-facing name of the task that may be used to populate a UI.", + "type": "string" + }, "params": { "description": "Params is a list of input parameters required to run the task. Params must be supplied as inputs in TaskRuns unless they declare a default value.", "type": "array",