Skip to content

Commit

Permalink
chore: generate docs for new fields
Browse files Browse the repository at this point in the history
  • Loading branch information
@nanjingfm
nanjingfm committed Mar 8, 2023
1 parent 925b286 commit a71d124
Show file tree
Hide file tree
Showing 5 changed files with 279 additions and 0 deletions.
169 changes: 169 additions & 0 deletions docs/pipeline-api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,19 @@ PipelineSpec
<table>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is a user-facing name of the pipeline that may be
used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
Expand Down Expand Up @@ -895,6 +908,19 @@ value.</p>
</tr>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is a user-facing name of the task that may be
used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
Expand Down Expand Up @@ -2474,6 +2500,19 @@ TaskRunStatus
<tbody>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is a user-facing name of the pipeline that may be
used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
Expand Down Expand Up @@ -2590,6 +2629,32 @@ the execution order of tasks relative to one another.</p>
</tr>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is the display name of this task within the context of a Pipeline.
This display name may be used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>Description is the description of this task within the context of a Pipeline.
This description may be used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>taskRef</code><br/>
<em>
<a href="#tekton.dev/v1.TaskRef">
Expand Down Expand Up @@ -5281,6 +5346,19 @@ value.</p>
</tr>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is a user-facing name of the task that may be
used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
Expand Down Expand Up @@ -7263,6 +7341,19 @@ value.</p>
</tr>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is a user-facing name of the task that may be
used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
Expand Down Expand Up @@ -7621,6 +7712,19 @@ PipelineSpec
<table>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is a user-facing name of the pipeline that may be
used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
Expand Down Expand Up @@ -8055,6 +8159,19 @@ value.</p>
</tr>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is a user-facing name of the task that may be
used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
Expand Down Expand Up @@ -10263,6 +10380,19 @@ TaskRunStatus
<tbody>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is a user-facing name of the pipeline that may be
used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
Expand Down Expand Up @@ -10393,6 +10523,32 @@ the execution order of tasks relative to one another.</p>
</tr>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is the display name of this task within the context of a Pipeline.
This display name may be used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>Description is the description of this task within the context of a Pipeline.
This description may be used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>taskRef</code><br/>
<em>
<a href="#tekton.dev/v1beta1.TaskRef">
Expand Down Expand Up @@ -13762,6 +13918,19 @@ value.</p>
</tr>
<tr>
<td>
<code>displayName</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>DisplayName is a user-facing name of the task that may be
used to populate a UI.</p>
</td>
</tr>
<tr>
<td>
<code>description</code><br/>
<em>
string
Expand Down
35 changes: 35 additions & 0 deletions pkg/apis/pipeline/v1/openapi_generated.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions pkg/apis/pipeline/v1/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down Expand Up @@ -816,6 +820,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",
Expand Down Expand Up @@ -867,6 +875,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"
Expand Down Expand Up @@ -2070,6 +2086,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",
Expand Down
Loading

0 comments on commit a71d124

Please sign in to comment.