{
"openapi": "3.0.0",
"tags": [
{
"name": "Pipeline"
},
{
"name": "PipelineRuns"
},
{
"name": "Definitions"
},
{
"name": "Environment properties"
},
{
"name": "Triggers"
},
{
"name": "Trigger properties"
}
],
"info": {
"title": "CD Tekton Pipeline",
"description": "## Introduction\n\nIBM Cloud® Continuous Delivery Tekton pipelines leverage the open source [Tekton Pipelines](https://tekton.dev/) project to provide continuous integration and continuous deployment capabilities within Kubernetes clusters.\n\n[Tekton Pipelines](https://tekton.dev/) is an open source project that you can use to configure and run continuous integration and continuous deployment pipelines within a Kubernetes cluster. Tekton pipelines are defined in `yaml` files, which are typically stored in a Git repository (repo).\n\nFor more information about our Continuous Delivery Tekton pipeline, see [Working with Tekton pipelines.](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-tekton-pipelines)\n\nInstalling the Node SDK.\n\n```sh\nnpm install @ibm-cloud/continuous-delivery\n```\n\nFor more information, view the project on GitHub: [https://github.com/IBM/continuous-delivery-node-sdk](https://github.com/IBM/continuous-delivery-node-sdk)\n\nInstalling the Python SDK.\n\n```bash\npip install \"ibm-continuous-delivery\"\n```\n\nFor more information, view the project on GitHub: [https://github.com/IBM/continuous-delivery-python-sdk](https://github.com/IBM/continuous-delivery-python-sdk)\n\nInstalling the Go SDK.\n\nGo modules (recommended): Add the following import in your code and then run `go mod tidy`.\n\n```go\nimport (\n \"github.com/IBM/continuous-delivery-go-sdk/v2/cdtektonpipelinev2\"\n)\n```\n\nUsing Go get:\n\n```bash\ngo get -u github.com/IBM/continuous-delivery-go-sdk/v2/cdtektonpipelinev2\n```\n\nFor more information, view the project on GitHub: [https://github.com/IBM/continuous-delivery-go-sdk](https://github.com/IBM/continuous-delivery-go-sdk)\n\nInstalling the Java SDK.\n\nMaven example:\n```xml\n\n com.ibm.cloud\n cd-tekton-pileline\n 2.0.1\n\n```\n\nGradle example:\n```bash\ncompile 'com.ibm.cloud:cd-tekton-pileline:2.0.1'\n```\n\nFor more information, view the project on GitHub: https://github.com/IBM/continuous-delivery-java-sdk. See also [Using the SDK](https://github.com/IBM/ibm-cloud-sdk-common/blob/main/README.md#using-the-sdk).\n\n## Endpoint URL\n\n\nThe Continuous Delivery Tekton pipeline API uses the regional endpoints. When you call the API, add the path for each method to form the complete API endpoint for your requests:\n\nContinuous Delivery will be discontinued in the following regions on 12 February 2027: **au-syd**, **ca-mon**, **ca-tor**, **us-east**. On 12 June 2026, customers will no longer be able to create new resources in the affected regions. However, if a region has no active usage, the region may be discontinued earlier and stop accepting new instances. [Learn more](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-faq_region_feature_consolidation).\n\n* Dallas: `https://api.us-south.devops.cloud.ibm.com/pipeline/v2`\n* London: `https://api.eu-gb.devops.cloud.ibm.com/pipeline/v2`\n* Frankfurt: `https://api.eu-de.devops.cloud.ibm.com/pipeline/v2`\n* Tokyo: `https://api.jp-tok.devops.cloud.ibm.com/pipeline/v2`\n* São Paulo: `https://api.br-sao.devops.cloud.ibm.com/pipeline/v2`\n* Montreal (**deprecated**, limited availability region): `https://api.ca-mon.devops.cloud.ibm.com/pipeline/v2`\n* Sydney (**deprecated**): `https://api.au-syd.devops.cloud.ibm.com/pipeline/v2`\n* Toronto (**deprecated**): `https://api.ca-tor.devops.cloud.ibm.com/pipeline/v2`\n* Washington DC (**deprecated**): `https://api.us-east.devops.cloud.ibm.com/pipeline/v2`\n\n**Note**: The following regions have been discontinued and are no longer available:\n* Osaka (jp-osa)\n* Madrid (eu-es)\n\n## Authentication\n\nAuthentication to the Tekton pipeline V2 API is enforced by using an IBM Cloud Identity and Access Management (IAM) access token. The token determines the actions that a user has access to when they use the API.\n\nTo get an access token, use an API key. To get your API key, access the [IBM Cloud API keys page](https://cloud.ibm.com/iam/apikeys) and create your API key. You can use this key to generate your IAM access (bearer) token. To use the Tekton API, add your valid IAM token to the HTTP Authorization request header, for example, `-H \"Authorization: Bearer \"`.\n\nExample request to generate an access token, where `` is your [IBM Cloud API Key](https://cloud.ibm.com/iam/apikeys).:\n\n```bash\ncurl -X POST \\\n 'https://iam.cloud.ibm.com/identity/token' \\\n -H 'Content-Type:application/x-www-form-urlencoded' \\\n -H 'Accept:application/json' \\\n -d 'grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey='\n```\n\n From the result of this curl command, take the `access_token` value and use it in place of `` in the curl command below to authenticate into the Tekton API:\n\n```bash\ncurl -L --request GET \\\n 'https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/' \\\n --header 'Authorization: Bearer '\n```\n\nOr export the returned `access_token` value as an environment variable and use that variable in the curl command:\n\n```bash\nexport IAMTOKEN=\"\"\ncurl -L --request GET \\\n 'https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/' \\\n --header 'Authorization: Bearer ${IAMTOKEN}'\n```\n\n**Setting client options through environment variables**\n\nExample environment variables, where `` is an [IAM API key](https://cloud.ibm.com/iam/apikeys).\n\n```sh\nexport CD_TEKTON_PIPELINE_URL=https://api.us-south.devops.cloud.ibm.com/pipeline/v2\nexport CD_TEKTON_PIPELINE_AUTHTYPE=iam\nexport CD_TEKTON_PIPELINE_APIKEY=\n```\n\nExample of constructing the service client\n\n```go\nimport {\n \"github.com/IBM/continuous-delivery-go-sdk/v2/cdtektonpipelinev2\"\n}\n...\ncdTektonPipelineServiceOptions := &cdtektonpipelinev2.CdTektonPipelineV2Options{}\ncdTektonPipelineService, err = cdtektonpipelinev2.NewCdTektonPipelineV2UsingExternalConfig(cdTektonPipelineServiceOptions)\n```\n\n**Setting client options programmatically**\n\nConstruct the service client programmatically, where `` is your hardcoded [IAM API key](https://cloud.ibm.com/iam/apikeys).\n\n```javascript\nconst CdTektonPipelineV2 = require('@ibm-cloud/continuous-delivery/cd-tekton-pipeline/v2');\nconst { IamAuthenticator } = require('@ibm-cloud/continuous-delivery/auth');\n\n// Create an IAM authenticator.\nconst authenticator = new IamAuthenticator({\n apikey: ''\n});\n\n// Construct the service client.\nconst tektonService = new CdTektonPipelineV2({\n authenticator, // required\n serviceUrl: 'https://api.us-south.devops.cloud.ibm.com/pipeline/v2' // optional\n});\n```\n\n**Setting client options through external configuration**\n\nExample environment variables, where `` is an [IAM API key](https://cloud.ibm.com/iam/apikeys).\n\n```sh\nexport CD_TEKTON_PIPELINE_URL=https://api.us-south.devops.cloud.ibm.com/pipeline/v2\nexport CD_TEKTON_PIPELINE_AUTHTYPE=iam\nexport CD_TEKTON_PIPELINE_APIKEY=\n```\n\nConstruct the service client using external configuration. `CdTektonPipelineV2.newInstance()` initializes the client with the environment variables, using them for subsequent authentication.\n\n```javascript\nconst CdTektonPipelineV2 = require('@ibm-cloud/continuous-delivery/cd-tekton-pipeline/v2');\nconst tektonService = CdTektonPipelineV2.newInstance();\n```\n\n**Setting client options through external configuration**\n\nExample environment variables, where `` is an [IAM API key](https://cloud.ibm.com/iam/apikeys).\n\n```sh\nexport CD_TEKTON_PIPELINE_URL=https://api.us-south.devops.cloud.ibm.com/pipeline/v2\nexport CD_TEKTON_PIPELINE_AUTHTYPE=iam\nexport CD_TEKTON_PIPELINE_APIKEY=\n```\n\nExample of constructing the service client\n\n```python\nfrom ibm_continuous_delivery.cd_tekton_pipeline_v2 import CdTektonPipelineV2\nservice = CdTektonPipelineV2.new_instance()\n```\n\n**Setting client options programmatically**\n\nConstruct the service client programmatically, where `` is your hardcoded [IAM API key](https://cloud.ibm.com/iam/apikeys).\n\n```java\nimport com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2.CdTektonPipeline;\nimport com.ibm.cloud.sdk.core.security.Authenticator;\nimport com.ibm.cloud.sdk.core.security.IamAuthenticator;\n...\nAuthenticator authenticator = new IamAuthenticator.Builder()\n .apikey(\"\")\n .build();\nCdTektonPipeline pipelineSvc = new CdTektonPipeline(CdTektonPipeline.DEFAULT_SERVICE_NAME, authenticator);\n```\n\n## Error handling\n\nThis API uses standard HTTP response codes to indicate whether a method completed successfully. A `200` response indicates success. A `400` type response indicates a failure, and a `500` type response indicates an internal system error.\n\n| HTTP Error Code | Description | Recovery |\n|-----------------|-----------------------|-----------------------------------------------------------------------------|\n| `200` | Success | The request was successful. |\n| `400` | Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. |\n| `401` | Unauthorized | You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions. |\n| `404` | Not Found | The requested resource could not be found or The supplied authentication is not authorized to access '{namespace}'. |\n| `408` | Request Timeout | The connection to the server timed out. Wait a few minutes, then try again. |\n| `409` | Conflict | The entity is already in the requested state. |\n| `500` | Internal Server Error | *offering_name* is currently unavailable. Your request could not be processed. Wait a few minutes and try again. |\n\n**ErrorResponse**\n\n| Name | Type | Description |\n|----------------- | --------|--------------------------------------------------------|\n| `code` | Integer | HTTP error code. |\n| `error` | String | Human-readable error string, like 'Invalid image file'.|\n\n## Versioning\n\nAll Tekton pipeline API requests are prefixed with a segment that represents the API version. The latest version of the Tekton pipeline API is `v2`. The versions of individual components of Continuous Delivery, such as `toolchain` and `pipeline`, may change independently of each other.\n\n## Pagination\n\nSome API requests may return multiple results. To avoid performance problems, these results are returned one page at a time, with a limited number of results in each page. `GET` requests for the `/tekton_pipelines/{pipeline_id}/pipeline_runs` resource use pagination.\n\nThe fields `first`, `previous`, `next`, and `last` are included in the collection response as needed, depending on the number of the results. The `href` property for these fields contains a URL reference to the appropriate page of results from the collection resource. Pagination is token based, where the response will return results from the beginning of the collection and will provide the appropriate `next` link, which contains a `start` token, to traverse through the rest of the collection.\n\nThe default page size is 50 items, and the maximum size is 100 items. To control the page size, use the `limit` query parameter.\n\n## Rate limiting\n\nRate limits for API requests are enforced on this service. If the number of requests reaches the request limit within the specified time window, no further requests are accepted until after the time window. Clients that are blocked by rate limited should wait and try the request again later.\n\nAn HTTP status code of 429 indicates that the rate limit has been exceeded.\n\n## Glossary\n\n* **Tekton Pipeline**: Continuous Delivery Tekton pipeline\n* **Pipeline run**: Continuous Delivery Tekton pipeline run\n* **PipelineRun**: Pure Tekton pipeline [PipelineRuns](https://github.com/tektoncd/pipeline/blob/main/docs/pipelineruns.md)\n\n## Related APIs\n\n* [Toolchain](https://cloud.ibm.com/apidocs/toolchain)",
"version": "2.0.0",
"x-codegen-config": {
"go": {
"apiPackage": "github.com/IBM/continuous-delivery-go-sdk/v2",
"improvedNameFormatting": true
},
"java": {
"apiPackage": "github.com/IBM/continuous-delivery-java-sdk",
"improvedNameFormatting": true
},
"node": {
"apiPackage": "github.com/IBM/continuous-delivery-node-sdk",
"improvedNameFormatting": true
},
"python": {
"apiPackage": "github.com/IBM/continuous-delivery-python-sdk",
"improvedNameFormatting": true
},
"terraform": {
"apiEndpoint": "IBMCLOUD_TEKTON_PIPELINE_ENDPOINT"
}
},
"x-github": "https://github.ibm.com/cloud-api-docs/toolchain",
"x-github-issues": "https://github.ibm.com/cloud-api-docs/toolchain/issues/new",
"x-last-updated": "2026-04-30"
},
"servers": [
{
"url": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2",
"x-ibm-region": "us-south",
"description": "The host URL for Tekton Pipeline Service in the us-south region."
},
{
"url": "https://api.us-east.devops.cloud.ibm.com/pipeline/v2",
"x-ibm-region": "us-east",
"description": "The host URL for Tekton Pipeline Service in the us-east region."
},
{
"url": "https://api.eu-de.devops.cloud.ibm.com/pipeline/v2",
"x-ibm-region": "eu-de",
"description": "The host URL for Tekton Pipeline Service in the eu-de region."
},
{
"url": "https://api.eu-gb.devops.cloud.ibm.com/pipeline/v2",
"x-ibm-region": "eu-gb",
"description": "The host URL for Tekton Pipeline Service in the eu-gb region."
},
{
"url": "https://api.jp-tok.devops.cloud.ibm.com/pipeline/v2",
"x-ibm-region": "jp-tok",
"description": "The host URL for Tekton Pipeline Service in the jp-tok region."
},
{
"url": "https://api.au-syd.devops.cloud.ibm.com/pipeline/v2",
"x-ibm-region": "au-syd",
"description": "The host URL for Tekton Pipeline Service in the au-syd region."
},
{
"url": "https://api.ca-tor.devops.cloud.ibm.com/pipeline/v2",
"x-ibm-region": "ca-tor",
"description": "The host URL for Tekton Pipeline Service in the ca-tor region."
},
{
"url": "https://api.ca-mon.devops.cloud.ibm.com/pipeline/v2",
"x-ibm-region": "ca-mon",
"description": "Montreal (ca-mon) is a limited availability region and not generally available. The host URL for Tekton Pipeline Service in the ca-mon region."
},
{
"url": "https://api.br-sao.devops.cloud.ibm.com/pipeline/v2",
"x-ibm-region": "br-sao",
"description": "The host URL for Tekton Pipeline Service in the br-sao region."
}
],
"paths": {
"/tekton_pipelines": {
"post": {
"tags": [
"Pipeline"
],
"summary": "Create Tekton pipeline",
"description": "This request creates a Tekton pipeline. Requires a pipeline tool already created in the toolchain using the toolchain API https://cloud.ibm.com/apidocs/toolchain#create-tool, and use the tool ID to create the Tekton pipeline",
"operationId": "create_tekton_pipeline",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.create"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TektonPipelinePrototype"
},
"examples": {
"pipeline": {
"value": {
"id": "94619026-912b-4d92-8f51-6c74f0692d90",
"worker": {
"id": "public"
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Tekton pipeline data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TektonPipeline"
},
"example": {
"name": "ci-pipeline",
"runs_url": "https://cloud.ibm.com/devops/pipelines/tekton/94619026-912b-4d92-8f51-6c74f0692d90?env_id=ibm:ys1:us-south",
"resource_group": {
"id": "19c29990ffe42ce260f5a5cb64f54169"
},
"status": "configured",
"created_at": "2020-01-28T14:45:44.828Z",
"updated_at": "2021-11-18T01:16:00.724Z",
"toolchain": {
"id": "bf5fa00f-ddef-4298-b87b-aa8b6da0e1a6",
"crn": "crn:v1:staging:public:toolchain:us-south:a/0ba224679d6c697f9baee5e14ade83ac:bf5fa00f-ddef-4298-b87b-aa8b6da0e1a6::"
},
"properties": [],
"triggers": [],
"worker": {
"name": "IBM Managed workers (Tekton Pipelines v0.16.3) in DALLAS (Stage 1)",
"type": "public",
"id": "public"
},
"id": "94619026-912b-4d92-8f51-6c74f0692d90",
"enabled": true,
"definitions": [],
"build_number": 10,
"next_build_number": 11,
"enable_notifications": false,
"enable_partial_cloning": false,
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90"
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"id\": \"94619026-912b-4d92-8f51-6c74f0692d90\", \"worker\": { \"id\": \"public\" } }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"workerIdentityModel := &cdtektonpipelinev2.WorkerIdentity{\n",
" ID: core.StringPtr(\"public\"),\n",
"}\n",
"\n",
"createTektonPipelineOptions := cdTektonPipelineService.NewCreateTektonPipelineOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"createTektonPipelineOptions.SetWorker(workerIdentityModel)\n",
"\n",
"tektonPipeline, response, err := cdTektonPipelineService.CreateTektonPipeline(createTektonPipelineOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(tektonPipeline, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"// Request models needed by this operation.\n",
"\n",
"// WorkerIdentity\n",
"const workerIdentityModel = {\n",
" id: 'public',\n",
"};\n",
"\n",
"const params = {\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" worker: workerIdentityModel,\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.createTektonPipeline(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"worker_identity_model = {\n",
" 'id': 'public',\n",
"}\n",
"\n",
"response = cd_tekton_pipeline_service.create_tekton_pipeline(\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" worker=worker_identity_model,\n",
")\n",
"tekton_pipeline = response.get_result()\n",
"\n",
"print(json.dumps(tekton_pipeline, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"WorkerIdentity workerIdentityModel = new WorkerIdentity.Builder()\n",
" .id(\"public\")\n",
" .build();\n",
"CreateTektonPipelineOptions createTektonPipelineOptions = new CreateTektonPipelineOptions.Builder()\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .worker(workerIdentityModel)\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.createTektonPipeline(createTektonPipelineOptions).execute();\n",
"TektonPipeline tektonPipeline = response.getResult();\n",
"\n",
"System.out.println(tektonPipeline);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/id"
}
],
"get": {
"tags": [
"Pipeline"
],
"summary": "Get Tekton pipeline data",
"description": "This request retrieves the Tekton pipeline data for the pipeline identified by `{id}`",
"operationId": "get_tekton_pipeline",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.read"
}
]
},
"responses": {
"200": {
"description": "Tekton pipeline data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TektonPipeline"
},
"example": {
"name": "ci-pipeline",
"runs_url": "https://cloud.ibm.com/devops/pipelines/tekton/94619026-912b-4d92-8f51-6c74f0692d90?env_id=ibm:ys1:us-south",
"resource_group": {
"id": "19c29990ffe42ce260f5a5cb64f54169"
},
"status": "configured",
"created_at": "2020-01-28T14:45:44.828Z",
"updated_at": "2021-11-18T01:16:00.724Z",
"toolchain": {
"id": "bf5fa00f-ddef-4298-b87b-aa8b6da0e1a6",
"crn": "crn:v1:staging:public:toolchain:us-south:a/0ba224679d6c697f9baee5e14ade83ac:bf5fa00f-ddef-4298-b87b-aa8b6da0e1a6::"
},
"properties": [
{
"name": "pipeline-debug",
"value": "1",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/pipeline-debug"
}
],
"triggers": [
{
"id": "03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"enabled": true,
"name": "manual-trigger",
"type": "manual",
"event_listener": "manual-listener",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/03b05e3d-cb46-44c9-8a4a-f12b76d7ae57"
}
],
"worker": {
"name": "IBM Managed workers (Tekton Pipelines v0.16.3) in DALLAS (Stage 1)",
"type": "public",
"id": "public"
},
"build_number": 1,
"next_build_number": 2,
"id": "94619026-912b-4d92-8f51-6c74f0692d90",
"enabled": true,
"enable_notifications": false,
"enable_partial_cloning": false,
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90",
"definitions": [
{
"source": {
"type": "git",
"properties": {
"path": ".tekton",
"url": "https://github.com/open-toolchain/hello-tekton.git",
"branch": "master",
"tool": {
"id": "74895ba2-d6c9-4216-8a3e-eb883ae655d6"
}
}
},
"id": "22f92ab1-e0ac-4c65-84e7-8a4cb32dba0f",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions/22f92ab1-e0ac-4c65-84e7-8a4cb32dba0f"
}
]
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"getTektonPipelineOptions := cdTektonPipelineService.NewGetTektonPipelineOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"\n",
"tektonPipeline, response, err := cdTektonPipelineService.GetTektonPipeline(getTektonPipelineOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(tektonPipeline, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.getTektonPipeline(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.get_tekton_pipeline(\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
")\n",
"tekton_pipeline = response.get_result()\n",
"\n",
"print(json.dumps(tekton_pipeline, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"GetTektonPipelineOptions getTektonPipelineOptions = new GetTektonPipelineOptions.Builder()\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.getTektonPipeline(getTektonPipelineOptions).execute();\n",
"TektonPipeline tektonPipeline = response.getResult();\n",
"\n",
"System.out.println(tektonPipeline);"
]
}
]
}
]
}
}
},
"patch": {
"tags": [
"Pipeline"
],
"summary": "Update Tekton pipeline data",
"description": "This request updates Tekton pipeline data, such as the worker ID or build number, for example. Use other endpoints such as /definitions, /triggers, and /properties for other configuration updates",
"operationId": "update_tekton_pipeline",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"x-codegen-request-body-name": "TektonPipelinePatch",
"requestBody": {
"content": {
"application/merge-patch+json": {
"schema": {
"$ref": "#/components/schemas/TektonPipelinePatch"
},
"examples": {
"pipeline": {
"value": {
"worker": {
"id": "public"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Tekton pipeline data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TektonPipeline"
},
"example": {
"name": "ci-pipeline",
"runs_url": "https://cloud.ibm.com/devops/pipelines/tekton/94619026-912b-4d92-8f51-6c74f0692d90?env_id=ibm:ys1:us-south",
"resource_group": {
"id": "19c29990ffe42ce260f5a5cb64f54169"
},
"status": "configured",
"created_at": "2020-01-28T14:45:44.828Z",
"updated_at": "2021-11-18T01:16:00.724Z",
"toolchain": {
"id": "bf5fa00f-ddef-4298-b87b-aa8b6da0e1a6",
"crn": "crn:v1:staging:public:toolchain:us-south:a/0ba224679d6c697f9baee5e14ade83ac:bf5fa00f-ddef-4298-b87b-aa8b6da0e1a6::"
},
"properties": [
{
"name": "pipeline-debug",
"value": "1",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/pipeline-debug"
}
],
"triggers": [
{
"id": "03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"enabled": true,
"name": "manual-trigger",
"type": "manual",
"event_listener": "manual-listener"
}
],
"worker": {
"name": "IBM Managed workers (Tekton Pipelines v0.16.3) in DALLAS (Stage 1)",
"type": "public",
"id": "public"
},
"build_number": 1,
"next_build_number": 2,
"id": "94619026-912b-4d92-8f51-6c74f0692d90",
"enabled": true,
"enable_notifications": false,
"enable_partial_cloning": false,
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90",
"definitions": [
{
"source": {
"type": "git",
"properties": {
"path": ".tekton",
"url": "https://github.com/open-toolchain/hello-tekton.git",
"branch": "master",
"tool": {
"id": "74895ba2-d6c9-4216-8a3e-eb883ae655d6"
}
}
},
"id": "22f92ab1-e0ac-4c65-84e7-8a4cb32dba0f",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions/22f92ab1-e0ac-4c65-84e7-8a4cb32dba0f"
}
]
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X PATCH --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/merge-patch+json\" \\\n",
" --data '{\"worker\":{\"id\":\"public\"}}' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"workerIdentityModel := &cdtektonpipelinev2.WorkerIdentity{\n",
" ID: core.StringPtr(\"public\"),\n",
"}\n",
"\n",
"tektonPipelinePatchModel := &cdtektonpipelinev2.TektonPipelinePatch{\n",
" Worker: workerIdentityModel,\n",
"}\n",
"tektonPipelinePatchModelAsPatch, asPatchErr := tektonPipelinePatchModel.AsPatch()\n",
"Expect(asPatchErr).To(BeNil())\n",
"\n",
"updateTektonPipelineOptions := cdTektonPipelineService.NewUpdateTektonPipelineOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"updateTektonPipelineOptions.SetTektonPipelinePatch(tektonPipelinePatchModelAsPatch)\n",
"\n",
"tektonPipeline, response, err := cdTektonPipelineService.UpdateTektonPipeline(updateTektonPipelineOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(tektonPipeline, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"// Request models needed by this operation.\n",
"\n",
"// WorkerIdentity\n",
"const workerIdentityModel = {\n",
" id: 'public',\n",
"};\n",
"\n",
"const params = {\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" worker: workerIdentityModel,\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.updateTektonPipeline(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"worker_identity_model = {\n",
" 'id': 'public',\n",
"}\n",
"\n",
"tekton_pipeline_patch_model = {\n",
" 'worker': worker_identity_model,\n",
"}\n",
"\n",
"response = cd_tekton_pipeline_service.update_tekton_pipeline(\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" tekton_pipeline_patch=tekton_pipeline_patch_model,\n",
")\n",
"tekton_pipeline = response.get_result()\n",
"\n",
"print(json.dumps(tekton_pipeline, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"WorkerIdentity workerIdentityModel = new WorkerIdentity.Builder()\n",
" .id(\"public\")\n",
" .build();\n",
"TektonPipelinePatch tektonPipelinePatchModel = new TektonPipelinePatch.Builder()\n",
" .worker(workerIdentityModel)\n",
" .build();\n",
"Map tektonPipelinePatchModelAsPatch = tektonPipelinePatchModel.asPatch();\n",
"UpdateTektonPipelineOptions updateTektonPipelineOptions = new UpdateTektonPipelineOptions.Builder()\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .tektonPipelinePatch(tektonPipelinePatchModelAsPatch)\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.updateTektonPipeline(updateTektonPipelineOptions).execute();\n",
"TektonPipeline tektonPipeline = response.getResult();\n",
"\n",
"System.out.println(tektonPipeline);"
]
}
]
}
]
}
}
},
"delete": {
"tags": [
"Pipeline"
],
"summary": "Delete a Tekton pipeline instance",
"description": "This request deletes the Tekton pipeline instance that is associated with the pipeline toolchain integration",
"operationId": "delete_tekton_pipeline",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.delete"
}
]
},
"responses": {
"204": {
"description": "Tekton pipeline instance deleted"
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"deleteTektonPipelineOptions := cdTektonPipelineService.NewDeleteTektonPipelineOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"\n",
"response, err := cdTektonPipelineService.DeleteTektonPipeline(deleteTektonPipelineOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"if response.StatusCode != 204 {\n",
" fmt.Printf(\"\\nUnexpected response status code received from DeleteTektonPipeline(): %d\\n\", response.StatusCode)\n",
"}"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
"};\n",
"\n",
"try {\n",
" await cdTektonPipelineService.deleteTektonPipeline(params);\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.delete_tekton_pipeline(\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
")"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"DeleteTektonPipelineOptions deleteTektonPipelineOptions = new DeleteTektonPipelineOptions.Builder()\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.deleteTektonPipeline(deleteTektonPipelineOptions).execute();"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/pipeline_runs": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
}
],
"get": {
"tags": [
"PipelineRuns"
],
"summary": "List pipeline run records",
"description": "This request lists pipeline run records, which have data about the runs, such as status, user_info, trigger and other information. Default limit is 50",
"operationId": "list_tekton_pipeline_runs",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline-run.read"
}
]
},
"parameters": [
{
"name": "start",
"in": "query",
"description": "A page token that identifies the start point of the list of pipeline runs. This value is included in the response body of each request to fetch pipeline runs",
"required": false,
"schema": {
"type": "string",
"pattern": "^[0-9a-zA-Z_.+-\\/=]*$",
"maxLength": 253,
"minLength": 0
}
},
{
"name": "limit",
"in": "query",
"description": "The number of pipeline runs to return, sorted by creation time, most recent first",
"required": false,
"schema": {
"format": "int32",
"type": "integer",
"default": 50,
"maximum": 100,
"minimum": 1
}
},
{
"name": "status",
"in": "query",
"description": "Filters the collection to resources with the specified status",
"required": false,
"schema": {
"$ref": "#/components/schemas/RunStatus"
}
},
{
"name": "trigger.name",
"in": "query",
"description": "Filters the collection to resources with the specified trigger name",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
},
"example": "manual-trigger"
}
],
"responses": {
"200": {
"description": "List of pipeline runs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PipelineRunsCollection"
},
"example": {
"pipeline_runs": [
{
"id": "1681024e-4dfe-40dd-922b-b55719120078",
"worker": {
"id": "6f97df8f-5727-4a2b-bb71-541ba8e3f71f",
"agent_id": "a2fd3205-0d94-47e1-a867-444a6185db51"
},
"user_info": {
"iam_id": "IBMid-310001SNXX",
"sub": "firstname@domain.com"
},
"status": "succeeded",
"pipeline_id": "94619026-912b-4d92-8f51-6c74f0692d90",
"pipeline": {
"id": "94619026-912b-4d92-8f51-6c74f0692d90"
},
"event_params_blob": "{\"message\":\"hello world\",\"flag\":\"no-go\",\"properties\":[{\"name\":\"pipeline-debug\",\"value\":\"from-API\",\"type\":\"text\"},{\"name\":\"pipeline-debug-2\",\"value\":\"from-api-2\",\"type\":\"text\"}]}",
"definition_id": "ee41a181-afed-4308-bf2a-84d6c677a005",
"definition": {
"id": "ee41a181-afed-4308-bf2a-84d6c677a005"
},
"listener_name": "manual-listener",
"created_at": "2021-11-23T21:28:03.824Z",
"build_number": 1387,
"trigger": {
"id": "03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"name": "manual-trigger",
"type": "manual",
"event_listener": "manual-listener",
"enabled": true,
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"properties": [
{
"name": "new",
"value": "123",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/03b05e3d-cb46-44c9-8a4a-f12b76d7ae57/properties/new"
}
]
},
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/1681024e-4dfe-40dd-922b-b55719120078",
"run_url": "https://cloud.ibm.com/devops/pipelines/tekton/94619026-912b-4d92-8f51-6c74f0692d90/runs/1681024e-4dfe-40dd-922b-b55719120078?env_id=ibm:ys1:us-south"
}
],
"limit": 10,
"first": {
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs?limit=10"
},
"next": {
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs?limit=10&start=MTY2MTkzNTY4MDMyMA=="
}
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline run not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs?status=succeeded&trigger.name=manual-trigger\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"listTektonPipelineRunsOptions := &cdtektonpipelinev2.ListTektonPipelineRunsOptions{\n",
" PipelineID: core.StringPtr(\"94619026-912b-4d92-8f51-6c74f0692d90\"),\n",
" Limit: core.Int64Ptr(int64(10)),\n",
" Status: core.StringPtr(\"succeeded\"),\n",
" TriggerName: core.StringPtr(\"manual-trigger\"),\n",
"}\n",
"\n",
"pager, err := cdTektonPipelineService.NewTektonPipelineRunsPager(listTektonPipelineRunsOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"\n",
"var allResults []cdtektonpipelinev2.PipelineRun\n",
"for pager.HasNext() {\n",
" nextPage, err := pager.GetNext()\n",
" if err != nil {\n",
" panic(err)\n",
" }\n",
" allResults = append(allResults, nextPage...)\n",
"}\n",
"b, _ := json.MarshalIndent(allResults, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" limit: 10,\n",
" status: 'succeeded',\n",
" triggerName: 'manual-trigger',\n",
"};\n",
"\n",
"const allResults = [];\n",
"try {\n",
" const pager = new CdTektonPipelineV2.TektonPipelineRunsPager(cdTektonPipelineService, params);\n",
" while (pager.hasNext()) {\n",
" const nextPage = await pager.getNext();\n",
" expect(nextPage).not.toBeNull();\n",
" allResults.push(...nextPage);\n",
" }\n",
" console.log(JSON.stringify(allResults, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"all_results = []\n",
"pager = TektonPipelineRunsPager(\n",
" client=cd_tekton_pipeline_service,\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" limit=10,\n",
" status='succeeded',\n",
" trigger_name='manual-trigger',\n",
")\n",
"while pager.has_next():\n",
" next_page = pager.get_next()\n",
" assert next_page is not None\n",
" all_results.extend(next_page)\n",
"\n",
"print(json.dumps(all_results, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"ListTektonPipelineRunsOptions listTektonPipelineRunsOptions = new ListTektonPipelineRunsOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .limit(Long.valueOf(\"10\"))\n",
" .status(\"succeeded\")\n",
" .triggerName(\"manual-trigger\")\n",
" .build();\n",
"\n",
"TektonPipelineRunsPager pager = new TektonPipelineRunsPager(cdTektonPipelineService, listTektonPipelineRunsOptions);\n",
"List allResults = new ArrayList<>();\n",
"while (pager.hasNext()) {\n",
" List nextPage = pager.getNext();\n",
" allResults.addAll(nextPage);\n",
"}\n",
"\n",
"System.out.println(GsonSingleton.getGson().toJson(allResults));"
]
}
]
}
]
}
}
},
"post": {
"tags": [
"PipelineRuns"
],
"summary": "Trigger a pipeline run",
"description": "Trigger a new pipeline run using either the manual or the timed trigger, specifying the additional properties or overriding existing ones as needed",
"operationId": "create_tekton_pipeline_run",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.pipeline-run.create"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline-run.create"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PipelineRunPrototype"
},
"examples": {
"trigger_example": {
"value": {
"description": "My custom manual PipelineRun",
"trigger": {
"name": "Manual Trigger 1",
"properties": {
"pipeline-debug": "false"
},
"secure_properties": {
"secure-property-key": "secure value"
},
"headers": {
"source": "api"
},
"body": {
"message": "hello world",
"enable": "true",
"detail": {
"name": "example"
}
}
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Pipeline run result and its status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PipelineRun"
},
"example": {
"pipeline_id": "94619026-912b-4d92-8f51-6c74f0692d90",
"pipeline": {
"id": "94619026-912b-4d92-8f51-6c74f0692d90"
},
"status": "pending",
"properties": [
{
"name": "pipeline-debug",
"value": "from-API",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/pipeline-debug"
}
],
"listener_name": "manual-listener",
"trigger": {
"name": "manual-trigger",
"event_listener": "manual-listener",
"type": "manual",
"id": "1bb892a1-2e04-4768-a369-b1159eace147",
"enabled": true
},
"type": "pipeline_run",
"description": "My custom manual PipelineRun",
"created_at": "2022-02-03T20:49:02.124Z",
"updated_at": "2022-02-03T20:49:02.124Z",
"id": "c4d6e785-f890-4ee4-92dd-f690f95b41a2",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/c4d6e785-f890-4ee4-92dd-f690f95b41a2",
"run_url": "https://cloud.ibm.com/devops/pipelines/tekton/94619026-912b-4d92-8f51-6c74f0692d90/runs/c4d6e785-f890-4ee4-92dd-f690f95b41a2?env_id=ibm:ys1:us-south",
"worker": {
"id": "6f97df8f-5727-4a2b-bb71-541ba8e3f71f",
"name": "public"
},
"event_params_blob": "{\"message\":\"hello world\",\"flag\":\"no-go\",\"properties\":[{\"name\":\"pipeline-debug\",\"value\":\"from-API\",\"type\":\"text\"},{\"name\":\"pipeline-debug-2\",\"value\":\"from-api-2\",\"type\":\"text\"}]}",
"trigger_headers": "{\"x-forwarded-proto\":\"https\",\"user_iam_id\":\"IBMid-310001SNXX\",\"user_sub\":\"firstname@domain.com\",\"transaction-id\":\"3d20c668-856c-405b-93ee-157adb755111\",\"location\":\"my-post-man\",\"source\":\"post-man\",\"accept\":\"application/json\",\"x-request-id\":\"ba62177b-8e82-488f-9f41-68c43d7d1e21\",\"x-b3-traceid\":\"bd038d74d0ae28549e8915627ed817db\",\"x-b3-spanid\":\"e760ea7d4a6676d8\",\"x-b3-parentspanid\":\"9e8915627ed817db\",\"x-b3-sampled\":\"0\"}",
"definition_id": "ee41a181-afed-4308-bf2a-84d6c677a005",
"definition": {
"id": "ee41a181-afed-4308-bf2a-84d6c677a005"
}
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline run not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"description\": \"My custom manual PipelineRun\", \"trigger\": { \"name\": \"Manual Trigger 1\", \"properties\": { \"pipeline-debug\": \"false\" }, \"secure_properties\": { \"secure-property-key\": \"secure value\" }, \"headers\": { \"source\": \"api\" }, \"body\": { \"message\": \"hello world\", \"enable\": \"true\", \"detail\": { \"name\": \"example\" } } } }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"pipelineRunTriggerModel := &cdtektonpipelinev2.PipelineRunTrigger{\n",
" Name: core.StringPtr(\"Manual Trigger 1\"),\n",
"}\n",
"\n",
"createTektonPipelineRunOptions := cdTektonPipelineService.NewCreateTektonPipelineRunOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"createTektonPipelineRunOptions.SetDescription(\"My custom manual PipelineRun\")\n",
"createTektonPipelineRunOptions.SetTrigger(pipelineRunTriggerModel)\n",
"\n",
"pipelineRun, response, err := cdTektonPipelineService.CreateTektonPipelineRun(createTektonPipelineRunOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(pipelineRun, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"// Request models needed by this operation.\n",
"\n",
"// PipelineRunTrigger\n",
"const pipelineRunTriggerModel = {\n",
" name: 'Manual Trigger 1',\n",
" properties: { 'pipeline-debug': 'false' },\n",
" secure_properties: { 'secure-property-key': 'secure value' },\n",
" headers: { source: 'api' },\n",
" body: { message: 'hello world', enable: 'true', detail: { name: 'example' } },\n",
"};\n",
"\n",
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" description: 'My custom manual PipelineRun',\n",
" trigger: pipelineRunTriggerModel,\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.createTektonPipelineRun(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"pipeline_run_trigger_model = {\n",
" 'name': 'Manual Trigger 1',\n",
" 'properties': {'pipeline-debug': 'false'},\n",
" 'secure_properties': {'secure-property-key': 'secure value'},\n",
" 'headers': {'source': 'api'},\n",
" 'body': {'message': 'hello world', 'enable': 'true', 'detail': {'name': 'example'}},\n",
"}\n",
"\n",
"response = cd_tekton_pipeline_service.create_tekton_pipeline_run(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" description='My custom manual PipelineRun',\n",
" trigger=pipeline_run_trigger_model,\n",
")\n",
"pipeline_run = response.get_result()\n",
"\n",
"print(json.dumps(pipeline_run, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"PipelineRunTrigger pipelineRunTriggerModel = new PipelineRunTrigger.Builder()\n",
" .name(\"Manual Trigger 1\")\n",
" .build();\n",
"CreateTektonPipelineRunOptions createTektonPipelineRunOptions = new CreateTektonPipelineRunOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .description(\"My custom manual PipelineRun\")\n",
" .trigger(pipelineRunTriggerModel)\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.createTektonPipelineRun(createTektonPipelineRunOptions).execute();\n",
"PipelineRun pipelineRun = response.getResult();\n",
"\n",
"System.out.println(pipelineRun);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/pipeline_runs/{id}": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/id"
}
],
"get": {
"tags": [
"PipelineRuns"
],
"summary": "Get a pipeline run record",
"description": "This request retrieves details of the pipeline run identified by `{id}`",
"operationId": "get_tekton_pipeline_run",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline-run.read"
}
]
},
"parameters": [
{
"name": "includes",
"in": "query",
"description": "Defines if response includes definition metadata",
"required": false,
"style": "form",
"explode": false,
"example": "definitions",
"schema": {
"$ref": "#/components/schemas/RunIncludes"
}
}
],
"responses": {
"200": {
"description": "Pipeline run detail",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PipelineRun"
},
"example": {
"id": "1681024e-4dfe-40dd-922b-b55719120078",
"worker": {
"id": "6f97df8f-5727-4a2b-bb71-541ba8e3f71f",
"agent_id": "a2fd3205-0d94-47e1-a867-444a6185db51",
"service_id": "ServiceId-43c88414-f9f7-44da-95b5-91bf55722025",
"name": "public"
},
"user_info": {
"iam_id": "IBMid-310001SNXX",
"sub": "firstname@domain.com"
},
"status": "succeeded",
"description": "My custom manual PipelineRun",
"pipeline_id": "94619026-912b-4d92-8f51-6c74f0692d90",
"pipeline": {
"id": "94619026-912b-4d92-8f51-6c74f0692d90"
},
"event_params_blob": "{\"message\":\"hello world\",\"flag\":\"no-go\",\"properties\":[{\"name\":\"pipeline-debug\",\"value\":\"from-API\",\"type\":\"text\"},{\"name\":\"pipeline-debug-2\",\"value\":\"from-api-2\",\"type\":\"text\"}]}",
"trigger_headers": "{\"x-forwarded-proto\":\"https\",\"user_iam_id\":\"IBMid-310001SNXX\",\"user_sub\":\"firstname@domain.com\",\"transaction-id\":\"95fd8923-fd75-4792-bfdd-07fd55d64fdc\",\"location\":\"my-post-man\",\"source\":\"post-man\",\"accept\":\"application/json\",\"x-request-id\":\"9292303b-92cd-48b2-9d80-e89cd0a19b3c\",\"x-b3-traceid\":\"8d423b020f5a9d30f2b505f644d9c1d5\",\"x-b3-spanid\":\"ee3d59e5925ce12f\",\"x-b3-parentspanid\":\"f2b505f644d9c1d5\",\"x-b3-sampled\":\"0\"}",
"definition_id": "ee41a181-afed-4308-bf2a-84d6c677a005",
"definition": {
"id": "ee41a181-afed-4308-bf2a-84d6c677a005"
},
"listener_name": "manual-listener",
"created_at": "2021-11-23T21:28:03.824Z",
"updated_at": "2022-01-28T19:05:45.764Z",
"build_number": 1387,
"trigger": {
"id": "03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"name": "manual-trigger",
"enabled": true,
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"type": "manual",
"event_listener": "manual-listener",
"properties": [
{
"name": "new",
"value": "123",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/03b05e3d-cb46-44c9-8a4a-f12b76d7ae57/properties/new"
}
]
},
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/1681024e-4dfe-40dd-922b-b55719120078",
"run_url": "https://cloud.ibm.com/devops/pipelines/tekton/94619026-912b-4d92-8f51-6c74f0692d90/runs/1681024e-4dfe-40dd-922b-b55719120078?env_id=ibm:ys1:us-south",
"definitions": [
{
"sha": "4162b1ebfd45538b5e258baf8cd51f3425149d03",
"repo_url": "https://github.com/open-toolchain/hello-tekton.git",
"id": "e92705ed-e0a0-4f3a-94ed-830df2c4f7fd",
"path": ".tekton",
"commit_url": "https://github.com/IBM/tekton-tutorial/commit/4162b1ebfd45538b5e258baf8cd51f3425149d03"
}
]
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline run not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/94619026-912b-4d92-8f51-6c74f0692d90?includes=definitions\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"getTektonPipelineRunOptions := cdTektonPipelineService.NewGetTektonPipelineRunOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"getTektonPipelineRunOptions.SetIncludes(\"definitions\")\n",
"\n",
"pipelineRun, response, err := cdTektonPipelineService.GetTektonPipelineRun(getTektonPipelineRunOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(pipelineRun, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" includes: 'definitions',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.getTektonPipelineRun(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.get_tekton_pipeline_run(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" includes='definitions',\n",
")\n",
"pipeline_run = response.get_result()\n",
"\n",
"print(json.dumps(pipeline_run, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"GetTektonPipelineRunOptions getTektonPipelineRunOptions = new GetTektonPipelineRunOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .includes(\"definitions\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.getTektonPipelineRun(getTektonPipelineRunOptions).execute();\n",
"PipelineRun pipelineRun = response.getResult();\n",
"\n",
"System.out.println(pipelineRun);"
]
}
]
}
]
}
}
},
"delete": {
"tags": [
"PipelineRuns"
],
"summary": "Delete a pipeline run record",
"description": "This request deletes the pipeline run record identified by `{id}`",
"operationId": "delete_tekton_pipeline_run",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline-run.delete"
}
]
},
"responses": {
"204": {
"description": "Pipeline run deleted"
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline run not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/94619026-912b-4d92-8f51-6c74f0692d90\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"deleteTektonPipelineRunOptions := cdTektonPipelineService.NewDeleteTektonPipelineRunOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"\n",
"response, err := cdTektonPipelineService.DeleteTektonPipelineRun(deleteTektonPipelineRunOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"if response.StatusCode != 204 {\n",
" fmt.Printf(\"\\nUnexpected response status code received from DeleteTektonPipelineRun(): %d\\n\", response.StatusCode)\n",
"}"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
"};\n",
"\n",
"try {\n",
" await cdTektonPipelineService.deleteTektonPipelineRun(params);\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.delete_tekton_pipeline_run(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
")"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"DeleteTektonPipelineRunOptions deleteTektonPipelineRunOptions = new DeleteTektonPipelineRunOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.deleteTektonPipelineRun(deleteTektonPipelineRunOptions).execute();"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/pipeline_runs/{id}/cancel": {
"post": {
"tags": [
"PipelineRuns"
],
"summary": "Cancel a pipeline run",
"description": "This request cancels a running pipeline run identified by `{id}`. Use `force: true` in the body if the pipeline run can't be cancelled normally",
"operationId": "cancel_tekton_pipeline_run",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline-run.update"
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/id"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelBody"
},
"examples": {
"force_cancel": {
"value": {
"force": true
}
}
}
}
}
},
"responses": {
"202": {
"description": "Pipeline run detail",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PipelineRun"
},
"example": {
"id": "1681024e-4dfe-40dd-922b-b55719120078",
"worker": {
"id": "6f97df8f-5727-4a2b-bb71-541ba8e3f71f",
"agent_id": "a2fd3205-0d94-47e1-a867-444a6185db51",
"service_id": "ServiceId-43c88414-f9f7-44da-95b5-91bf55722025",
"name": "public"
},
"user_info": {
"iam_id": "IBMid-310001SNXX",
"sub": "firstname@domain.com"
},
"status": "cancelled",
"pipeline_id": "94619026-912b-4d92-8f51-6c74f0692d90",
"pipeline": {
"id": "94619026-912b-4d92-8f51-6c74f0692d90"
},
"event_params_blob": "{\"message\":\"hello world\",\"flag\":\"no-go\",\"properties\":[{\"name\":\"pipeline-debug\",\"value\":\"from-API\",\"type\":\"text\"},{\"name\":\"pipeline-debug-2\",\"value\":\"from-api-2\",\"type\":\"text\"}]}",
"trigger_headers": "{\"x-forwarded-proto\":\"https\",\"user_iam_id\":\"IBMid-310001SNXX\",\"user_sub\":\"firstname@domain.com\",\"transaction-id\":\"95fd8923-fd75-4792-bfdd-07fd55d64fdc\",\"location\":\"my-post-man\",\"source\":\"post-man\",\"accept\":\"application/json\",\"x-request-id\":\"9292303b-92cd-48b2-9d80-e89cd0a19b3c\",\"x-b3-traceid\":\"8d423b020f5a9d30f2b505f644d9c1d5\",\"x-b3-spanid\":\"ee3d59e5925ce12f\",\"x-b3-parentspanid\":\"f2b505f644d9c1d5\",\"x-b3-sampled\":\"0\"}",
"definition_id": "ee41a181-afed-4308-bf2a-84d6c677a005",
"definition": {
"id": "ee41a181-afed-4308-bf2a-84d6c677a005"
},
"listener_name": "manual-listener",
"description": "My custom manual PipelineRun",
"created_at": "2021-11-23T21:28:03.824Z",
"updated_at": "2022-01-28T19:05:45.764Z",
"build_number": 1388,
"trigger": {
"id": "03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"name": "manual-trigger",
"type": "manual",
"enabled": true,
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"event_listener": "manual-listener",
"properties": [
{
"name": "new",
"value": "123",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/03b05e3d-cb46-44c9-8a4a-f12b76d7ae57/properties/new"
}
]
},
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/1681024e-4dfe-40dd-922b-b55719120078",
"run_url": "https://cloud.ibm.com/devops/pipelines/tekton/94619026-912b-4d92-8f51-6c74f0692d90/runs/1681024e-4dfe-40dd-922b-b55719120078?env_id=ibm:ys1:us-south",
"definitions": [
{
"sha": "4162b1ebfd45538b5e258baf8cd51f3425149d03",
"repo_url": "https://github.com/open-toolchain/hello-tekton.git",
"id": "e92705ed-e0a0-4f3a-94ed-830df2c4f7fd",
"path": ".tekton",
"commit_url": "https://github.com/IBM/tekton-tutorial/commit/4162b1ebfd45538b5e258baf8cd51f3425149d03"
}
]
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline run not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"force\": true }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/94619026-912b-4d92-8f51-6c74f0692d90/cancel\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"cancelTektonPipelineRunOptions := cdTektonPipelineService.NewCancelTektonPipelineRunOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"cancelTektonPipelineRunOptions.SetForce(true)\n",
"\n",
"pipelineRun, response, err := cdTektonPipelineService.CancelTektonPipelineRun(cancelTektonPipelineRunOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(pipelineRun, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" force: true,\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.cancelTektonPipelineRun(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.cancel_tekton_pipeline_run(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" force=True,\n",
")\n",
"pipeline_run = response.get_result()\n",
"\n",
"print(json.dumps(pipeline_run, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"CancelTektonPipelineRunOptions cancelTektonPipelineRunOptions = new CancelTektonPipelineRunOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .force(true)\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.cancelTektonPipelineRun(cancelTektonPipelineRunOptions).execute();\n",
"PipelineRun pipelineRun = response.getResult();\n",
"\n",
"System.out.println(pipelineRun);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/pipeline_runs/{id}/rerun": {
"post": {
"tags": [
"PipelineRuns"
],
"summary": "Rerun a pipeline run",
"description": "This request reruns a past pipeline run, which is identified by `{id}`, with the same data. Request body isn't allowed",
"operationId": "rerun_tekton_pipeline_run",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.pipeline-run.create"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline-run.update"
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/id"
}
],
"responses": {
"201": {
"description": "Pipeline run detail",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PipelineRun"
},
"example": {
"id": "1681024e-4dfe-40dd-922b-b55719120078",
"worker": {
"id": "6f97df8f-5727-4a2b-bb71-541ba8e3f71f",
"agent_id": "a2fd3205-0d94-47e1-a867-444a6185db51",
"service_id": "ServiceId-43c88414-f9f7-44da-95b5-91bf55722025",
"name": "public"
},
"user_info": {
"iam_id": "IBMid-310001SNXX",
"sub": "firstname@domain.com"
},
"status": "waiting",
"pipeline_id": "94619026-912b-4d92-8f51-6c74f0692d90",
"pipeline": {
"id": "94619026-912b-4d92-8f51-6c74f0692d90"
},
"event_params_blob": "{\"message\":\"hello world\",\"flag\":\"no-go\",\"properties\":[{\"name\":\"pipeline-debug\",\"value\":\"from-API\",\"type\":\"text\"},{\"name\":\"pipeline-debug-2\",\"value\":\"from-api-2\",\"type\":\"text\"}]}",
"trigger_headers": "{\"x-forwarded-proto\":\"https\",\"user_iam_id\":\"IBMid-310001SNXX\",\"user_sub\":\"firstname@domain.com\",\"transaction-id\":\"95fd8923-fd75-4792-bfdd-07fd55d64fdc\",\"location\":\"my-post-man\",\"source\":\"post-man\",\"accept\":\"application/json\",\"x-request-id\":\"9292303b-92cd-48b2-9d80-e89cd0a19b3c\",\"x-b3-traceid\":\"8d423b020f5a9d30f2b505f644d9c1d5\",\"x-b3-spanid\":\"ee3d59e5925ce12f\",\"x-b3-parentspanid\":\"f2b505f644d9c1d5\",\"x-b3-sampled\":\"0\"}",
"definition_id": "ee41a181-afed-4308-bf2a-84d6c677a005",
"definition": {
"id": "ee41a181-afed-4308-bf2a-84d6c677a005"
},
"listener_name": "manual-listener",
"description": "My custom manual PipelineRun",
"created_at": "2021-11-23T21:28:03.824Z",
"updated_at": "2022-01-28T19:05:45.764Z",
"build_number": 1387,
"trigger": {
"id": "03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"name": "manual-trigger",
"type": "manual",
"enabled": true,
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/03b05e3d-cb46-44c9-8a4a-f12b76d7ae57",
"event_listener": "manual-listener",
"properties": [
{
"name": "new",
"value": "123",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/03b05e3d-cb46-44c9-8a4a-f12b76d7ae57/properties/new"
}
]
},
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/1681024e-4dfe-40dd-922b-b55719120078",
"run_url": "https://cloud.ibm.com/devops/pipelines/tekton/94619026-912b-4d92-8f51-6c74f0692d90/runs/1681024e-4dfe-40dd-922b-b55719120078?env_id=ibm:ys1:us-south",
"definitions": [
{
"sha": "4162b1ebfd45538b5e258baf8cd51f3425149d03",
"repo_url": "https://github.com/open-toolchain/hello-tekton.git",
"id": "e92705ed-e0a0-4f3a-94ed-830df2c4f7fd",
"path": ".tekton",
"commit_url": "https://github.com/IBM/tekton-tutorial/commit/4162b1ebfd45538b5e258baf8cd51f3425149d03"
}
]
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline run not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/94619026-912b-4d92-8f51-6c74f0692d90/rerun\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"rerunTektonPipelineRunOptions := cdTektonPipelineService.NewRerunTektonPipelineRunOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"\n",
"pipelineRun, response, err := cdTektonPipelineService.RerunTektonPipelineRun(rerunTektonPipelineRunOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(pipelineRun, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.rerunTektonPipelineRun(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.rerun_tekton_pipeline_run(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
")\n",
"pipeline_run = response.get_result()\n",
"\n",
"print(json.dumps(pipeline_run, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"RerunTektonPipelineRunOptions rerunTektonPipelineRunOptions = new RerunTektonPipelineRunOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.rerunTektonPipelineRun(rerunTektonPipelineRunOptions).execute();\n",
"PipelineRun pipelineRun = response.getResult();\n",
"\n",
"System.out.println(pipelineRun);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/pipeline_runs/{id}/logs": {
"get": {
"tags": [
"PipelineRuns"
],
"summary": "Get a list of pipeline run log objects",
"description": "This request fetches a list of log data for a pipeline run identified by `{id}`. The `href` in each log entry can be used to fetch that individual log",
"operationId": "get_tekton_pipeline_run_logs",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline-run.read"
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/id"
}
],
"responses": {
"200": {
"description": "List of pipeline run log objects",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogsCollection"
},
"example": {
"logs": [
{
"name": "pipelinerun-e1e46c2d-d260-48b6-85a8-884e596b904e-console--92ll6/echo-text-step-0",
"id": "031903d9-0893-4681-b3a3-b736ed03f0fd",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/e1e46c2d-d260-48b6-85a8-884e596b904e/logs/031903d9-0893-4681-b3a3-b736ed03f0fd"
},
{
"name": "pipelinerun-e1e46c2d-d260-48b6-85a8-884e596b904e-console--92ll6/echo-text-step-1",
"id": "0b5f5501-cc97-442c-9786-e70d3d12319a",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/e1e46c2d-d260-48b6-85a8-884e596b904e/logs/0b5f5501-cc97-442c-9786-e70d3d12319a"
}
]
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline run not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/94619026-912b-4d92-8f51-6c74f0692d90/logs\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"getTektonPipelineRunLogsOptions := cdTektonPipelineService.NewGetTektonPipelineRunLogsOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"\n",
"logsCollection, response, err := cdTektonPipelineService.GetTektonPipelineRunLogs(getTektonPipelineRunLogsOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(logsCollection, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.getTektonPipelineRunLogs(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.get_tekton_pipeline_run_logs(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
")\n",
"logs_collection = response.get_result()\n",
"\n",
"print(json.dumps(logs_collection, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"GetTektonPipelineRunLogsOptions getTektonPipelineRunLogsOptions = new GetTektonPipelineRunLogsOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.getTektonPipelineRunLogs(getTektonPipelineRunLogsOptions).execute();\n",
"LogsCollection logsCollection = response.getResult();\n",
"\n",
"System.out.println(logsCollection);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/pipeline_runs/{pipeline_run_id}/logs/{id}": {
"get": {
"tags": [
"PipelineRuns"
],
"summary": "Get the log content of a pipeline run step",
"description": "This request retrieves the log content of a pipeline run step, where the step is identified by `{id}`. To get the log ID use the endpoint `/tekton_pipelines/{pipeline_id}/pipeline_runs/{id}/logs`",
"operationId": "get_tekton_pipeline_run_log_content",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline-run.read"
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/pipelineRunId"
},
{
"$ref": "#/components/parameters/id"
}
],
"responses": {
"200": {
"description": "Log content of a step",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StepLog"
},
"example": {
"data": "log content",
"id": "e92705ed-e0a0-4f3a-94ed-830df2c4f7fd"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline run logs not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/pipeline_runs/bf4b3abd-0c93-416b-911e-9cf42f1a1085/logs/94619026-912b-4d92-8f51-6c74f0692d90\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"getTektonPipelineRunLogContentOptions := cdTektonPipelineService.NewGetTektonPipelineRunLogContentOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"bf4b3abd-0c93-416b-911e-9cf42f1a1085\",\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"\n",
"stepLog, response, err := cdTektonPipelineService.GetTektonPipelineRunLogContent(getTektonPipelineRunLogContentOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(stepLog, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" pipelineRunId: 'bf4b3abd-0c93-416b-911e-9cf42f1a1085',\n",
" id: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.getTektonPipelineRunLogContent(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.get_tekton_pipeline_run_log_content(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" pipeline_run_id='bf4b3abd-0c93-416b-911e-9cf42f1a1085',\n",
" id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
")\n",
"step_log = response.get_result()\n",
"\n",
"print(json.dumps(step_log, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"GetTektonPipelineRunLogContentOptions getTektonPipelineRunLogContentOptions = new GetTektonPipelineRunLogContentOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .pipelineRunId(\"bf4b3abd-0c93-416b-911e-9cf42f1a1085\")\n",
" .id(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.getTektonPipelineRunLogContent(getTektonPipelineRunLogContentOptions).execute();\n",
"StepLog stepLog = response.getResult();\n",
"\n",
"System.out.println(stepLog);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/definitions": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
}
],
"get": {
"tags": [
"Definitions"
],
"summary": "List pipeline definitions",
"description": "This request fetches pipeline definitions, which is a collection of individual definition entries. Each entry consists of a repository url, a repository path and a branch or tag. The referenced repository URL must match the URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools. The branch or tag of the definition must match against a corresponding branch or tag in the chosen repository, and the path must match a subfolder in the repository",
"operationId": "list_tekton_pipeline_definitions",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.read"
}
]
},
"responses": {
"200": {
"description": "List of pipeline definitions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefinitionsCollection"
},
"example": {
"definitions": [
{
"source": {
"type": "git",
"properties": {
"path": ".tekton",
"url": "https://github.com/open-toolchain/hello-tekton.git",
"branch": "master",
"tool": {
"id": "74895ba2-d6c9-4216-8a3e-eb883ae655d6"
}
}
},
"id": "94299034-d45f-4e9a-8ed5-6bd5c7bb7ada",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions/94299034-d45f-4e9a-8ed5-6bd5c7bb7ada"
}
]
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"listTektonPipelineDefinitionsOptions := cdTektonPipelineService.NewListTektonPipelineDefinitionsOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"\n",
"definitionsCollection, response, err := cdTektonPipelineService.ListTektonPipelineDefinitions(listTektonPipelineDefinitionsOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(definitionsCollection, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.listTektonPipelineDefinitions(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.list_tekton_pipeline_definitions(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
")\n",
"definitions_collection = response.get_result()\n",
"\n",
"print(json.dumps(definitions_collection, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"ListTektonPipelineDefinitionsOptions listTektonPipelineDefinitionsOptions = new ListTektonPipelineDefinitionsOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.listTektonPipelineDefinitions(listTektonPipelineDefinitionsOptions).execute();\n",
"DefinitionsCollection definitionsCollection = response.getResult();\n",
"\n",
"System.out.println(definitionsCollection);"
]
}
]
}
]
}
}
},
"post": {
"tags": [
"Definitions"
],
"summary": "Create a single definition",
"description": "This request adds a single definition. The source properties should consist of a repository url, a repository path and a branch or tag. The referenced repository URL must match the URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools. The branch or tag of the definition must match against a corresponding branch or tag in the chosen repository, and the path must match a subfolder in the repository",
"operationId": "create_tekton_pipeline_definition",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefinitionPrototype"
},
"examples": {
"definition": {
"value": {
"source": {
"type": "git",
"properties": {
"path": ".tekton",
"url": "https://github.com/open-toolchain/hello-tekton.git",
"branch": "master"
}
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "The added definition",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Definition"
},
"example": {
"source": {
"type": "git",
"properties": {
"path": ".tekton",
"url": "https://github.com/open-toolchain/hello-tekton.git",
"branch": "master",
"tool": {
"id": "74895ba2-d6c9-4216-8a3e-eb883ae655d6"
}
}
},
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions/94299034-d45f-4e9a-8ed5-6bd5c7bb7ada",
"id": "94299034-d45f-4e9a-8ed5-6bd5c7bb7ada"
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"source\": { \"type\": \"git\", \"properties\": { \"path\": \".tekton\", \"url\": \"https://github.com/open-toolchain/hello-tekton.git\", \"branch\": \"master\" } } }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"definitionSourcePropertiesModel := &cdtektonpipelinev2.DefinitionSourceProperties{\n",
" URL: core.StringPtr(\"https://github.com/open-toolchain/hello-tekton.git\"),\n",
" Branch: core.StringPtr(\"master\"),\n",
" Path: core.StringPtr(\".tekton\"),\n",
"}\n",
"\n",
"definitionSourceModel := &cdtektonpipelinev2.DefinitionSource{\n",
" Type: core.StringPtr(\"git\"),\n",
" Properties: definitionSourcePropertiesModel,\n",
"}\n",
"\n",
"createTektonPipelineDefinitionOptions := cdTektonPipelineService.NewCreateTektonPipelineDefinitionOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" definitionSourceModel,\n",
")\n",
"\n",
"definition, response, err := cdTektonPipelineService.CreateTektonPipelineDefinition(createTektonPipelineDefinitionOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(definition, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"// Request models needed by this operation.\n",
"\n",
"// DefinitionSourceProperties\n",
"const definitionSourcePropertiesModel = {\n",
" url: 'https://github.com/open-toolchain/hello-tekton.git',\n",
" branch: 'master',\n",
" path: '.tekton',\n",
"};\n",
"\n",
"// DefinitionSource\n",
"const definitionSourceModel = {\n",
" type: 'git',\n",
" properties: definitionSourcePropertiesModel,\n",
"};\n",
"\n",
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" source: definitionSourceModel,\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.createTektonPipelineDefinition(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"definition_source_properties_model = {\n",
" 'url': 'https://github.com/open-toolchain/hello-tekton.git',\n",
" 'branch': 'master',\n",
" 'path': '.tekton',\n",
"}\n",
"\n",
"definition_source_model = {\n",
" 'type': 'git',\n",
" 'properties': definition_source_properties_model,\n",
"}\n",
"\n",
"response = cd_tekton_pipeline_service.create_tekton_pipeline_definition(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" source=definition_source_model,\n",
")\n",
"definition = response.get_result()\n",
"\n",
"print(json.dumps(definition, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"DefinitionSourceProperties definitionSourcePropertiesModel = new DefinitionSourceProperties.Builder()\n",
" .url(\"https://github.com/open-toolchain/hello-tekton.git\")\n",
" .branch(\"master\")\n",
" .path(\".tekton\")\n",
" .build();\n",
"DefinitionSource definitionSourceModel = new DefinitionSource.Builder()\n",
" .type(\"git\")\n",
" .xProperties(definitionSourcePropertiesModel)\n",
" .build();\n",
"CreateTektonPipelineDefinitionOptions createTektonPipelineDefinitionOptions = new CreateTektonPipelineDefinitionOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .source(definitionSourceModel)\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.createTektonPipelineDefinition(createTektonPipelineDefinitionOptions).execute();\n",
"Definition definition = response.getResult();\n",
"\n",
"System.out.println(definition);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/definitions/{definition_id}": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/definitionId"
}
],
"get": {
"tags": [
"Definitions"
],
"summary": "Retrieve a single definition entry",
"description": "This request fetches a single definition entry, which consists of the definition repository URL, a repository path, and a branch or tag",
"operationId": "get_tekton_pipeline_definition",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.read"
}
]
},
"responses": {
"200": {
"description": "The requested definition entry",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Definition"
},
"example": {
"source": {
"type": "git",
"properties": {
"path": ".tekton",
"url": "https://github.com/open-toolchain/hello-tekton.git",
"branch": "master",
"tool": {
"id": "74895ba2-d6c9-4216-8a3e-eb883ae655d6"
}
}
},
"id": "94299034-d45f-4e9a-8ed5-6bd5c7bb7ada",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions/94299034-d45f-4e9a-8ed5-6bd5c7bb7ada"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Definition not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions/94299034-d45f-4e9a-8ed5-6bd5c7bb7ada\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"getTektonPipelineDefinitionOptions := cdTektonPipelineService.NewGetTektonPipelineDefinitionOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"94299034-d45f-4e9a-8ed5-6bd5c7bb7ada\",\n",
")\n",
"\n",
"definition, response, err := cdTektonPipelineService.GetTektonPipelineDefinition(getTektonPipelineDefinitionOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(definition, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" definitionId: '94299034-d45f-4e9a-8ed5-6bd5c7bb7ada',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.getTektonPipelineDefinition(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.get_tekton_pipeline_definition(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" definition_id='94299034-d45f-4e9a-8ed5-6bd5c7bb7ada',\n",
")\n",
"definition = response.get_result()\n",
"\n",
"print(json.dumps(definition, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"GetTektonPipelineDefinitionOptions getTektonPipelineDefinitionOptions = new GetTektonPipelineDefinitionOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .definitionId(\"94299034-d45f-4e9a-8ed5-6bd5c7bb7ada\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.getTektonPipelineDefinition(getTektonPipelineDefinitionOptions).execute();\n",
"Definition definition = response.getResult();\n",
"\n",
"System.out.println(definition);"
]
}
]
}
]
}
}
},
"put": {
"tags": [
"Definitions"
],
"summary": "Edit a single definition entry",
"description": "This request updates a definition entry identified by `{definition_id}`",
"operationId": "replace_tekton_pipeline_definition",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefinitionPrototype"
},
"examples": {
"definition": {
"value": {
"source": null,
"type": "git",
"properties": {
"path": ".tekton",
"url": "https://github.com/open-toolchain/hello-tekton.git",
"branch": "master"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Updated definition metadata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Definition"
},
"example": {
"source": {
"type": "git",
"properties": {
"path": ".tekton",
"url": "https://github.com/open-toolchain/hello-tekton.git",
"branch": "master",
"tool": {
"id": "74895ba2-d6c9-4216-8a3e-eb883ae655d6"
}
}
},
"id": "22f92ab1-e0ac-4c65-84e7-8a4cb32dba0f",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions/22f92ab1-e0ac-4c65-84e7-8a4cb32dba0f"
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Definition not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{\"source\":null,\"type\":\"git\",\"properties\":{\"path\":\".tekton\",\"url\":\"https://github.com/open-toolchain/hello-tekton.git\",\"branch\":\"master\"}}' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions/94299034-d45f-4e9a-8ed5-6bd5c7bb7ada\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"definitionSourcePropertiesModel := &cdtektonpipelinev2.DefinitionSourceProperties{\n",
" URL: core.StringPtr(\"testString\"),\n",
" Path: core.StringPtr(\"testString\"),\n",
"}\n",
"\n",
"definitionSourceModel := &cdtektonpipelinev2.DefinitionSource{\n",
" Type: core.StringPtr(\"testString\"),\n",
" Properties: definitionSourcePropertiesModel,\n",
"}\n",
"\n",
"replaceTektonPipelineDefinitionOptions := cdTektonPipelineService.NewReplaceTektonPipelineDefinitionOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"94299034-d45f-4e9a-8ed5-6bd5c7bb7ada\",\n",
" definitionSourceModel,\n",
")\n",
"\n",
"definition, response, err := cdTektonPipelineService.ReplaceTektonPipelineDefinition(replaceTektonPipelineDefinitionOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(definition, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"// Request models needed by this operation.\n",
"\n",
"// DefinitionSourceProperties\n",
"const definitionSourcePropertiesModel = {\n",
" url: 'testString',\n",
" path: 'testString',\n",
"};\n",
"\n",
"// DefinitionSource\n",
"const definitionSourceModel = {\n",
" type: 'testString',\n",
" properties: definitionSourcePropertiesModel,\n",
"};\n",
"\n",
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" definitionId: '94299034-d45f-4e9a-8ed5-6bd5c7bb7ada',\n",
" source: definitionSourceModel,\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.replaceTektonPipelineDefinition(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"definition_source_properties_model = {\n",
" 'url': 'testString',\n",
" 'path': 'testString',\n",
"}\n",
"\n",
"definition_source_model = {\n",
" 'type': 'testString',\n",
" 'properties': definition_source_properties_model,\n",
"}\n",
"\n",
"response = cd_tekton_pipeline_service.replace_tekton_pipeline_definition(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" definition_id='94299034-d45f-4e9a-8ed5-6bd5c7bb7ada',\n",
" source=definition_source_model,\n",
")\n",
"definition = response.get_result()\n",
"\n",
"print(json.dumps(definition, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"DefinitionSourceProperties definitionSourcePropertiesModel = new DefinitionSourceProperties.Builder()\n",
" .url(\"testString\")\n",
" .path(\"testString\")\n",
" .build();\n",
"DefinitionSource definitionSourceModel = new DefinitionSource.Builder()\n",
" .type(\"testString\")\n",
" .xProperties(definitionSourcePropertiesModel)\n",
" .build();\n",
"ReplaceTektonPipelineDefinitionOptions replaceTektonPipelineDefinitionOptions = new ReplaceTektonPipelineDefinitionOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .definitionId(\"94299034-d45f-4e9a-8ed5-6bd5c7bb7ada\")\n",
" .source(definitionSourceModel)\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.replaceTektonPipelineDefinition(replaceTektonPipelineDefinitionOptions).execute();\n",
"Definition definition = response.getResult();\n",
"\n",
"System.out.println(definition);"
]
}
]
}
]
}
}
},
"delete": {
"tags": [
"Definitions"
],
"summary": "Delete a single definition entry",
"description": "This request deletes a single definition from the definition list",
"operationId": "delete_tekton_pipeline_definition",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"responses": {
"204": {
"description": "Definition deleted"
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Definition not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/definitions/94299034-d45f-4e9a-8ed5-6bd5c7bb7ada\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"deleteTektonPipelineDefinitionOptions := cdTektonPipelineService.NewDeleteTektonPipelineDefinitionOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"94299034-d45f-4e9a-8ed5-6bd5c7bb7ada\",\n",
")\n",
"\n",
"response, err := cdTektonPipelineService.DeleteTektonPipelineDefinition(deleteTektonPipelineDefinitionOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"if response.StatusCode != 204 {\n",
" fmt.Printf(\"\\nUnexpected response status code received from DeleteTektonPipelineDefinition(): %d\\n\", response.StatusCode)\n",
"}"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" definitionId: '94299034-d45f-4e9a-8ed5-6bd5c7bb7ada',\n",
"};\n",
"\n",
"try {\n",
" await cdTektonPipelineService.deleteTektonPipelineDefinition(params);\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.delete_tekton_pipeline_definition(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" definition_id='94299034-d45f-4e9a-8ed5-6bd5c7bb7ada',\n",
")"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"DeleteTektonPipelineDefinitionOptions deleteTektonPipelineDefinitionOptions = new DeleteTektonPipelineDefinitionOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .definitionId(\"94299034-d45f-4e9a-8ed5-6bd5c7bb7ada\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.deleteTektonPipelineDefinition(deleteTektonPipelineDefinitionOptions).execute();"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/properties": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
}
],
"get": {
"tags": [
"Environment properties"
],
"summary": "List the pipeline's environment properties",
"description": "This request lists the environment properties of the pipeline identified by `{pipeline_id}`",
"operationId": "list_tekton_pipeline_properties",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.read"
}
]
},
"parameters": [
{
"name": "name",
"in": "query",
"description": "Filters the collection to resources with the specified property name",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
},
"example": "prod"
},
{
"name": "type",
"in": "query",
"description": "Filters the collection to resources with the specified property type",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"minItems": 0,
"maxItems": 5,
"items": {
"$ref": "#/components/schemas/PropertyType"
}
},
"example": [
"secure",
"text"
]
},
{
"name": "sort",
"in": "query",
"description": "Sorts the returned properties by name, in ascending order using `name` or in descending order using `-name`",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
},
"example": "name"
}
],
"responses": {
"200": {
"description": "List of pipeline's environment properties",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PropertiesCollection"
},
"example": {
"properties": [
{
"name": "ad123",
"value": "ad123-value",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/ad123"
}
]
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties?name=prod&type=[ \\\"secure\\\", \\\"text\\\" ]&sort=name\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"listTektonPipelinePropertiesOptions := cdTektonPipelineService.NewListTektonPipelinePropertiesOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"listTektonPipelinePropertiesOptions.SetName(\"prod\")\n",
"listTektonPipelinePropertiesOptions.SetType([]string{\"secure\", \"text\"})\n",
"listTektonPipelinePropertiesOptions.SetSort(\"name\")\n",
"\n",
"propertiesCollection, response, err := cdTektonPipelineService.ListTektonPipelineProperties(listTektonPipelinePropertiesOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(propertiesCollection, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" name: 'prod',\n",
" type: ['secure', 'text'],\n",
" sort: 'name',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.listTektonPipelineProperties(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.list_tekton_pipeline_properties(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" name='prod',\n",
" type=['secure', 'text'],\n",
" sort='name',\n",
")\n",
"properties_collection = response.get_result()\n",
"\n",
"print(json.dumps(properties_collection, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"ListTektonPipelinePropertiesOptions listTektonPipelinePropertiesOptions = new ListTektonPipelinePropertiesOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .name(\"prod\")\n",
" .type(java.util.Arrays.asList(\"secure\", \"text\"))\n",
" .sort(\"name\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.listTektonPipelineProperties(listTektonPipelinePropertiesOptions).execute();\n",
"PropertiesCollection propertiesCollection = response.getResult();\n",
"\n",
"System.out.println(propertiesCollection);"
]
}
]
}
]
}
}
},
"post": {
"tags": [
"Environment properties"
],
"summary": "Create a pipeline environment property",
"description": "This request creates an environment property",
"operationId": "create_tekton_pipeline_properties",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PropertyPrototype"
},
"examples": {
"text_env_property": {
"value": {
"name": "prop1",
"value": "https://github.com/open-toolchain/hello-tekton.git",
"type": "text"
}
},
"secure_env_property": {
"value": {
"name": "secret1",
"value": "C1V8amO0VYga5gD7PstC8mhnLi9iYVaWUb/CHLoFWGpSnf8c7LBwT4picQRBXlKa2WG5eEn534mB2eorKfetEw==",
"type": "secure"
}
},
"single_select_env_properties": {
"value": {
"name": "enums",
"type": "single_select",
"enum": [
"option1",
"option2",
"option3"
],
"value": "option1"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Environment property added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Property"
},
"example": {
"name": "ad123",
"value": "ad123-value",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/ad123"
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"name\": \"prop1\", \"value\": \"https://github.com/open-toolchain/hello-tekton.git\", \"type\": \"text\" }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"createTektonPipelinePropertiesOptions := cdTektonPipelineService.NewCreateTektonPipelinePropertiesOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"prop1\",\n",
" \"text\",\n",
")\n",
"createTektonPipelinePropertiesOptions.SetValue(\"https://github.com/open-toolchain/hello-tekton.git\")\n",
"\n",
"property, response, err := cdTektonPipelineService.CreateTektonPipelineProperties(createTektonPipelinePropertiesOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(property, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" name: 'prop1',\n",
" type: 'text',\n",
" value: 'https://github.com/open-toolchain/hello-tekton.git',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.createTektonPipelineProperties(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.create_tekton_pipeline_properties(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" name='prop1',\n",
" type='text',\n",
" value='https://github.com/open-toolchain/hello-tekton.git',\n",
")\n",
"property = response.get_result()\n",
"\n",
"print(json.dumps(property, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"CreateTektonPipelinePropertiesOptions createTektonPipelinePropertiesOptions = new CreateTektonPipelinePropertiesOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .name(\"prop1\")\n",
" .type(\"text\")\n",
" .value(\"https://github.com/open-toolchain/hello-tekton.git\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.createTektonPipelineProperties(createTektonPipelinePropertiesOptions).execute();\n",
"Property property = response.getResult();\n",
"\n",
"System.out.println(property);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/properties/{property_name}": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/propertyName"
}
],
"get": {
"tags": [
"Environment properties"
],
"summary": "Get a pipeline environment property",
"description": "This request gets the data of an environment property identified by `{property_name}`",
"operationId": "get_tekton_pipeline_property",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.read"
}
]
},
"responses": {
"200": {
"description": "Single property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Property"
},
"example": {
"name": "ad123",
"value": "ad123-value",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/ad123"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline property not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/debug-pipeline\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"getTektonPipelinePropertyOptions := cdTektonPipelineService.NewGetTektonPipelinePropertyOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"debug-pipeline\",\n",
")\n",
"\n",
"property, response, err := cdTektonPipelineService.GetTektonPipelineProperty(getTektonPipelinePropertyOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(property, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" propertyName: 'debug-pipeline',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.getTektonPipelineProperty(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.get_tekton_pipeline_property(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" property_name='debug-pipeline',\n",
")\n",
"property = response.get_result()\n",
"\n",
"print(json.dumps(property, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"GetTektonPipelinePropertyOptions getTektonPipelinePropertyOptions = new GetTektonPipelinePropertyOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .propertyName(\"debug-pipeline\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.getTektonPipelineProperty(getTektonPipelinePropertyOptions).execute();\n",
"Property property = response.getResult();\n",
"\n",
"System.out.println(property);"
]
}
]
}
]
}
}
},
"put": {
"tags": [
"Environment properties"
],
"summary": "Replace the value of an environment property",
"description": "This request updates the value of an environment property identified by `{property_name}`, its type and name are immutable",
"operationId": "replace_tekton_pipeline_property",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PropertyPrototype"
},
"examples": {
"single_env_property": {
"value": {
"name": "prop1",
"value": "https://github.com/open-toolchain/hello-tekton.git",
"type": "text"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Replaced pipeline property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Property"
},
"example": {
"name": "ad123",
"value": "ad123-value",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/ad123"
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline property not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"name\": \"prop1\", \"value\": \"https://github.com/open-toolchain/hello-tekton.git\", \"type\": \"text\" }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/debug-pipeline\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"replaceTektonPipelinePropertyOptions := cdTektonPipelineService.NewReplaceTektonPipelinePropertyOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"debug-pipeline\",\n",
" \"prop1\",\n",
" \"text\",\n",
")\n",
"replaceTektonPipelinePropertyOptions.SetValue(\"https://github.com/open-toolchain/hello-tekton.git\")\n",
"\n",
"property, response, err := cdTektonPipelineService.ReplaceTektonPipelineProperty(replaceTektonPipelinePropertyOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(property, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" propertyName: 'debug-pipeline',\n",
" name: 'prop1',\n",
" type: 'text',\n",
" value: 'https://github.com/open-toolchain/hello-tekton.git',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.replaceTektonPipelineProperty(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.replace_tekton_pipeline_property(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" property_name='debug-pipeline',\n",
" name='prop1',\n",
" type='text',\n",
" value='https://github.com/open-toolchain/hello-tekton.git',\n",
")\n",
"property = response.get_result()\n",
"\n",
"print(json.dumps(property, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"ReplaceTektonPipelinePropertyOptions replaceTektonPipelinePropertyOptions = new ReplaceTektonPipelinePropertyOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .propertyName(\"debug-pipeline\")\n",
" .name(\"prop1\")\n",
" .type(\"text\")\n",
" .value(\"https://github.com/open-toolchain/hello-tekton.git\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.replaceTektonPipelineProperty(replaceTektonPipelinePropertyOptions).execute();\n",
"Property property = response.getResult();\n",
"\n",
"System.out.println(property);"
]
}
]
}
]
}
}
},
"delete": {
"tags": [
"Environment properties"
],
"summary": "Delete a single pipeline environment property",
"description": "This request deletes a single pipeline environment property",
"operationId": "delete_tekton_pipeline_property",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"responses": {
"204": {
"description": "Property deleted"
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline property not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/debug-pipeline\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"deleteTektonPipelinePropertyOptions := cdTektonPipelineService.NewDeleteTektonPipelinePropertyOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"debug-pipeline\",\n",
")\n",
"\n",
"response, err := cdTektonPipelineService.DeleteTektonPipelineProperty(deleteTektonPipelinePropertyOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"if response.StatusCode != 204 {\n",
" fmt.Printf(\"\\nUnexpected response status code received from DeleteTektonPipelineProperty(): %d\\n\", response.StatusCode)\n",
"}"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" propertyName: 'debug-pipeline',\n",
"};\n",
"\n",
"try {\n",
" await cdTektonPipelineService.deleteTektonPipelineProperty(params);\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.delete_tekton_pipeline_property(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" property_name='debug-pipeline',\n",
")"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"DeleteTektonPipelinePropertyOptions deleteTektonPipelinePropertyOptions = new DeleteTektonPipelinePropertyOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .propertyName(\"debug-pipeline\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.deleteTektonPipelineProperty(deleteTektonPipelinePropertyOptions).execute();"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/triggers": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
}
],
"get": {
"tags": [
"Triggers"
],
"summary": "List pipeline triggers",
"description": "This request lists pipeline triggers for the pipeline identified by `{pipeline_id}`",
"operationId": "list_tekton_pipeline_triggers",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.read"
}
]
},
"parameters": [
{
"name": "type",
"in": "query",
"description": "Optional filter by \"type\", accepts a comma separated list of types. Valid types are \"manual\", \"scm\", \"generic\", and \"timer\"",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
},
"example": "manual,scm"
},
{
"name": "name",
"in": "query",
"description": "Optional filter by \"name\", accepts a single string value",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
}
},
{
"name": "event_listener",
"in": "query",
"description": "Optional filter by \"event_listener\", accepts a single string value",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
}
},
{
"name": "worker.id",
"in": "query",
"description": "Optional filter by \"worker.id\", accepts a single string value",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
}
},
{
"name": "worker.name",
"in": "query",
"description": "Optional filter by \"worker.name\", accepts a single string value",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
}
},
{
"name": "disabled",
"in": "query",
"description": "Optional filter by \"disabled\" state, possible values are \"true\" or \"false\"",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
},
"example": "true"
},
{
"name": "tags",
"in": "query",
"description": "Optional filter by \"tags\", accepts a comma separated list of tags. The response lists triggers having at least one matching tag",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
},
"example": "tag1,tag2"
}
],
"responses": {
"200": {
"description": "List of triggers for the pipeline identified by `{pipeline_id}`",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggersCollection"
},
"example": {
"triggers": [
{
"type": "scm",
"name": "git-trigger",
"event_listener": "pr-listener",
"id": "50283ad5-90f3-48f1-9a59-47e8abf0062b",
"enabled": true,
"tags": [
"tag1",
"tag2"
],
"properties": [
{
"name": "asd",
"value": "asd",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/50283ad5-90f3-48f1-9a59-47e8abf0062b/properties/asd"
}
],
"source": {
"type": "git",
"properties": {
"url": "https://github.com/open-toolchain/hello-tekton.git",
"blind_connection": false,
"branch": "master",
"hook_id": "330377364",
"tool": {
"id": "74895ba2-d6c9-4216-8a3e-eb883ae655d6"
}
}
},
"events": [
"push",
"pull_request"
],
"enable_events_from_forks": false,
"disable_draft_events": false,
"limit_waiting_runs": true,
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/50283ad5-90f3-48f1-9a59-47e8abf0062b"
},
{
"type": "manual",
"event_listener": "pr-listener",
"name": "Manual Trigger",
"enabled": true,
"limit_waiting_runs": true,
"max_concurrent_runs": 3,
"id": "ede11b98-b97d-4bea-a89a-339dfa52c56e",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/ede11b98-b97d-4bea-a89a-339dfa52c56e"
}
]
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers?type=manual,scm&disabled=true&tags=tag1,tag2\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"listTektonPipelineTriggersOptions := cdTektonPipelineService.NewListTektonPipelineTriggersOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
")\n",
"listTektonPipelineTriggersOptions.SetType(\"manual,scm\")\n",
"listTektonPipelineTriggersOptions.SetDisabled(\"true\")\n",
"listTektonPipelineTriggersOptions.SetTags(\"tag1,tag2\")\n",
"\n",
"triggersCollection, response, err := cdTektonPipelineService.ListTektonPipelineTriggers(listTektonPipelineTriggersOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(triggersCollection, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" type: 'manual,scm',\n",
" disabled: 'true',\n",
" tags: 'tag1,tag2',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.listTektonPipelineTriggers(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.list_tekton_pipeline_triggers(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" type='manual,scm',\n",
" disabled='true',\n",
" tags='tag1,tag2',\n",
")\n",
"triggers_collection = response.get_result()\n",
"\n",
"print(json.dumps(triggers_collection, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"ListTektonPipelineTriggersOptions listTektonPipelineTriggersOptions = new ListTektonPipelineTriggersOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .type(\"manual,scm\")\n",
" .disabled(\"true\")\n",
" .tags(\"tag1,tag2\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.listTektonPipelineTriggers(listTektonPipelineTriggersOptions).execute();\n",
"TriggersCollection triggersCollection = response.getResult();\n",
"\n",
"System.out.println(triggersCollection);"
]
}
]
}
]
}
}
},
"post": {
"tags": [
"Triggers"
],
"summary": "Create a trigger",
"description": "This request creates a trigger",
"operationId": "create_tekton_pipeline_trigger",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerPrototype"
},
"examples": {
"manual_trigger": {
"value": {
"type": "manual",
"event_listener": "pr-listener",
"name": "Manual Trigger",
"enabled": true,
"limit_waiting_runs": false,
"max_concurrent_runs": 3,
"worker": {
"id": "public"
}
}
},
"scm_trigger": {
"value": {
"type": "scm",
"event_listener": "pr-listener",
"name": "Git Trigger",
"enabled": true,
"limit_waiting_runs": true,
"source": {
"type": "git",
"properties": {
"url": "https://github.com/open-toolchain/hello-tekton.git",
"branch": "master"
}
},
"events": [
"push",
"pull_request"
],
"enable_events_from_forks": true,
"disable_draft_events": true,
"properties": [
{
"name": "prop1",
"value": "https://github.com/open-toolchain/hello-tekton.git",
"type": "text"
},
{
"name": "secret1",
"value": "C1V8amO0VYga5gD7PstC8mhnLi9iYVaWUb/CHLoFWGpSnf8c7LBwT4picQRBXlKa2WG5eEn534mB2eorKfetEw==",
"type": "secure"
},
{
"name": "enums",
"type": "single_select",
"enum": [
"option1",
"option2",
"option3"
],
"value": "option1"
}
]
}
},
"timer_trigger": {
"value": {
"type": "timer",
"enabled": true,
"event_listener": "pr-listener",
"name": "Timer Trigger",
"cron": "*/5 * * * *",
"timezone": "America/Toronto",
"worker": {
"id": "public"
}
}
},
"generic_trigger": {
"value": {
"type": "generic",
"name": "Generic Webhook Trigger",
"event_listener": "pr-listener",
"enabled": true,
"tags": [
"prod",
"dev"
],
"worker": {
"id": "5df804a4-9d7b-44e1-874f-3810866fb80b"
},
"secret": {
"value": "secret",
"type": "token_matches",
"source": "query",
"key_name": "auth"
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "The created trigger",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Trigger"
},
"example": {
"type": "scm",
"name": "git-trigger",
"event_listener": "pr-listener",
"enabled": true,
"id": "50283ad5-90f3-48f1-9a59-47e8abf0062b",
"tags": [
"tag1",
"tag2"
],
"properties": [
{
"name": "asd",
"value": "asd",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/50283ad5-90f3-48f1-9a59-47e8abf0062b/properties/asd"
}
],
"source": {
"type": "git",
"properties": {
"url": "https://github.com/open-toolchain/hello-tekton.git",
"type": "GitHub",
"blind_connection": false,
"branch": "master",
"hook_id": "330377364",
"tool": {
"id": "74895ba2-d6c9-4216-8a3e-eb883ae655d6"
}
}
},
"events": [
"push",
"pull_request",
"pull_request_closed"
],
"enable_events_from_forks": false,
"disable_draft_events": false,
"limit_waiting_runs": true
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Pipeline not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"type\": \"manual\", \"event_listener\": \"pr-listener\", \"name\": \"Manual Trigger\", \"enabled\": true, \"limit_waiting_runs\": false, \"max_concurrent_runs\": 3, \"worker\": { \"id\": \"public\" } }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"workerIdentityModel := &cdtektonpipelinev2.WorkerIdentity{\n",
" ID: core.StringPtr(\"public\"),\n",
"}\n",
"\n",
"createTektonPipelineTriggerOptions := cdTektonPipelineService.NewCreateTektonPipelineTriggerOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"manual\",\n",
" \"Manual Trigger\",\n",
" \"pr-listener\",\n",
")\n",
"createTektonPipelineTriggerOptions.SetWorker(workerIdentityModel)\n",
"createTektonPipelineTriggerOptions.SetMaxConcurrentRuns(int64(3))\n",
"createTektonPipelineTriggerOptions.SetLimitWaitingRuns(false)\n",
"createTektonPipelineTriggerOptions.SetEnabled(true)\n",
"\n",
"trigger, response, err := cdTektonPipelineService.CreateTektonPipelineTrigger(createTektonPipelineTriggerOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(trigger, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"// Request models needed by this operation.\n",
"\n",
"// WorkerIdentity\n",
"const workerIdentityModel = {\n",
" id: 'public',\n",
"};\n",
"\n",
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" type: 'manual',\n",
" name: 'Manual Trigger',\n",
" eventListener: 'pr-listener',\n",
" worker: workerIdentityModel,\n",
" maxConcurrentRuns: 3,\n",
" limitWaitingRuns: false,\n",
" enabled: true,\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.createTektonPipelineTrigger(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"worker_identity_model = {\n",
" 'id': 'public',\n",
"}\n",
"\n",
"response = cd_tekton_pipeline_service.create_tekton_pipeline_trigger(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" type='manual',\n",
" name='Manual Trigger',\n",
" event_listener='pr-listener',\n",
" worker=worker_identity_model,\n",
" max_concurrent_runs=3,\n",
" limit_waiting_runs=False,\n",
" enabled=True,\n",
")\n",
"trigger = response.get_result()\n",
"\n",
"print(json.dumps(trigger, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"WorkerIdentity workerIdentityModel = new WorkerIdentity.Builder()\n",
" .id(\"public\")\n",
" .build();\n",
"CreateTektonPipelineTriggerOptions createTektonPipelineTriggerOptions = new CreateTektonPipelineTriggerOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .type(\"manual\")\n",
" .name(\"Manual Trigger\")\n",
" .eventListener(\"pr-listener\")\n",
" .worker(workerIdentityModel)\n",
" .maxConcurrentRuns(Long.valueOf(\"3\"))\n",
" .limitWaitingRuns(false)\n",
" .enabled(true)\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.createTektonPipelineTrigger(createTektonPipelineTriggerOptions).execute();\n",
"Trigger trigger = response.getResult();\n",
"\n",
"System.out.println(trigger);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/triggers/{trigger_id}": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/triggerId"
}
],
"get": {
"tags": [
"Triggers"
],
"summary": "Get a single trigger",
"description": "This request retrieves a single trigger identified by `{trigger_id}`",
"operationId": "get_tekton_pipeline_trigger",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.read"
}
]
},
"responses": {
"200": {
"description": "the trigger requested",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Trigger"
},
"example": {
"type": "generic",
"name": "generic webhook trigger",
"event_listener": "pr-listener",
"id": "62ec6bf4-8cb5-4713-b73a-7baaa9fa876e",
"tags": [
"tag2"
],
"enabled": true,
"secret": {
"type": "digest_matches",
"value": "hash:SHA3-512:4ce44af678a8acf09c99c2fb6b3b2b9f4e1d9fe016c268388f824cebed34f75c24f8177da5ea9d614fd2cd68ac35ad4da09d8f10f7f0216029f0639785552755",
"source": "query",
"key_name": "asd123",
"algorithm": "md4"
},
"webhook_url": "https://devops-api.us-south.devops.cloud.ibm.com/v1/tekton-webhook/94619026-912b-4d92-8f51-6c74f0692d90/run/62ec6bf4-8cb5-4713-b73a-7baaa9fa876e"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Trigger not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/1bb892a1-2e04-4768-a369-b1159eace147\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"getTektonPipelineTriggerOptions := cdTektonPipelineService.NewGetTektonPipelineTriggerOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"1bb892a1-2e04-4768-a369-b1159eace147\",\n",
")\n",
"\n",
"trigger, response, err := cdTektonPipelineService.GetTektonPipelineTrigger(getTektonPipelineTriggerOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(trigger, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" triggerId: '1bb892a1-2e04-4768-a369-b1159eace147',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.getTektonPipelineTrigger(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.get_tekton_pipeline_trigger(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" trigger_id='1bb892a1-2e04-4768-a369-b1159eace147',\n",
")\n",
"trigger = response.get_result()\n",
"\n",
"print(json.dumps(trigger, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"GetTektonPipelineTriggerOptions getTektonPipelineTriggerOptions = new GetTektonPipelineTriggerOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .triggerId(\"1bb892a1-2e04-4768-a369-b1159eace147\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.getTektonPipelineTrigger(getTektonPipelineTriggerOptions).execute();\n",
"Trigger trigger = response.getResult();\n",
"\n",
"System.out.println(trigger);"
]
}
]
}
]
}
}
},
"patch": {
"tags": [
"Triggers"
],
"summary": "Edit a trigger",
"description": "This request changes a single field or many fields of the trigger identified by `{trigger_id}`. Note that some fields are immutable, and use `/properties` endpoint to update trigger properties",
"operationId": "update_tekton_pipeline_trigger",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"x-codegen-request-body-name": "TriggerPatch",
"requestBody": {
"content": {
"application/merge-patch+json": {
"schema": {
"$ref": "#/components/schemas/TriggerPatch"
},
"examples": {
"change-trigger-name-state": {
"value": {
"name": "start-deploy"
}
},
"change-git-trigger-branch": {
"value": {
"source": {
"type": "git",
"properties": {
"branch": "master",
"url": "https://github.com/open-toolchain/hello-tekton.git"
}
}
}
},
"change-timer-trigger-cron": {
"value": {
"cron": "*/10 * * * *"
}
},
"change-generic-trigger-secret": {
"value": {
"secret": {
"value": "new-secret"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "The updated trigger",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Trigger"
},
"example": {
"timer_id": "958d621e-d067-410f-a842-bf1c51a43db4",
"enabled": true,
"name": "time trigger",
"event_listener": "pr-listener",
"cron": "*/5 * * * *",
"max_concurrent_runs": 2,
"tags": [
"tag2",
"tag3"
],
"timezone": "America/Toronto",
"type": "timer",
"id": "e3676049-e9f6-4f6a-b8eb-ac58e00c53f7"
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Trigger not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X PATCH --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/merge-patch+json\" \\\n",
" --data '{\"name\":\"start-deploy\"}' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/1bb892a1-2e04-4768-a369-b1159eace147\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"triggerPatchModel := &cdtektonpipelinev2.TriggerPatch{\n",
" Name: core.StringPtr(\"start-deploy\"),\n",
"}\n",
"triggerPatchModelAsPatch, asPatchErr := triggerPatchModel.AsPatch()\n",
"Expect(asPatchErr).To(BeNil())\n",
"\n",
"updateTektonPipelineTriggerOptions := cdTektonPipelineService.NewUpdateTektonPipelineTriggerOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"1bb892a1-2e04-4768-a369-b1159eace147\",\n",
")\n",
"updateTektonPipelineTriggerOptions.SetTriggerPatch(triggerPatchModelAsPatch)\n",
"\n",
"trigger, response, err := cdTektonPipelineService.UpdateTektonPipelineTrigger(updateTektonPipelineTriggerOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(trigger, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" triggerId: '1bb892a1-2e04-4768-a369-b1159eace147',\n",
" name: 'start-deploy',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.updateTektonPipelineTrigger(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"trigger_patch_model = {\n",
" 'name': 'start-deploy',\n",
"}\n",
"\n",
"response = cd_tekton_pipeline_service.update_tekton_pipeline_trigger(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" trigger_id='1bb892a1-2e04-4768-a369-b1159eace147',\n",
" trigger_patch=trigger_patch_model,\n",
")\n",
"trigger = response.get_result()\n",
"\n",
"print(json.dumps(trigger, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"TriggerPatch triggerPatchModel = new TriggerPatch.Builder()\n",
" .name(\"start-deploy\")\n",
" .build();\n",
"Map triggerPatchModelAsPatch = triggerPatchModel.asPatch();\n",
"UpdateTektonPipelineTriggerOptions updateTektonPipelineTriggerOptions = new UpdateTektonPipelineTriggerOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .triggerId(\"1bb892a1-2e04-4768-a369-b1159eace147\")\n",
" .triggerPatch(triggerPatchModelAsPatch)\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.updateTektonPipelineTrigger(updateTektonPipelineTriggerOptions).execute();\n",
"Trigger trigger = response.getResult();\n",
"\n",
"System.out.println(trigger);"
]
}
]
}
]
}
}
},
"delete": {
"tags": [
"Triggers"
],
"summary": "Delete a single trigger",
"description": "This request deletes the trigger identified by `{trigger_id}`",
"operationId": "delete_tekton_pipeline_trigger",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"responses": {
"204": {
"description": "The trigger was deleted"
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Trigger not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/1bb892a1-2e04-4768-a369-b1159eace147\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"deleteTektonPipelineTriggerOptions := cdTektonPipelineService.NewDeleteTektonPipelineTriggerOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"1bb892a1-2e04-4768-a369-b1159eace147\",\n",
")\n",
"\n",
"response, err := cdTektonPipelineService.DeleteTektonPipelineTrigger(deleteTektonPipelineTriggerOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"if response.StatusCode != 204 {\n",
" fmt.Printf(\"\\nUnexpected response status code received from DeleteTektonPipelineTrigger(): %d\\n\", response.StatusCode)\n",
"}"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" triggerId: '1bb892a1-2e04-4768-a369-b1159eace147',\n",
"};\n",
"\n",
"try {\n",
" await cdTektonPipelineService.deleteTektonPipelineTrigger(params);\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.delete_tekton_pipeline_trigger(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" trigger_id='1bb892a1-2e04-4768-a369-b1159eace147',\n",
")"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"DeleteTektonPipelineTriggerOptions deleteTektonPipelineTriggerOptions = new DeleteTektonPipelineTriggerOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .triggerId(\"1bb892a1-2e04-4768-a369-b1159eace147\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.deleteTektonPipelineTrigger(deleteTektonPipelineTriggerOptions).execute();"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/triggers/{source_trigger_id}/duplicate": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/sourceTriggerId"
}
],
"post": {
"tags": [
"Triggers"
],
"summary": "Duplicate a trigger",
"description": "This request duplicates a trigger from an existing trigger identified by `{source_trigger_id}`",
"operationId": "duplicate_tekton_pipeline_trigger",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DuplicateTrigger"
},
"examples": {
"duplicate_trigger": {
"value": {
"name": "triggerName"
}
}
}
}
}
},
"responses": {
"201": {
"description": "The created trigger, which is based on duplicating the source trigger's configuration except that some fields are updated to ensure uniqueness",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Trigger"
},
"example": {
"type": "scm",
"name": "triggerName",
"event_listener": "pr-listener",
"enabled": true,
"id": "50283ad5-90f3-48f1-9a59-47e8abf0062b",
"tags": [
"tag1",
"tag2"
],
"properties": [
{
"name": "asd",
"value": "asd",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/50283ad5-90f3-48f1-9a59-47e8abf0062b/properties/asd"
}
],
"source": {
"type": "git",
"properties": {
"url": "https://github.com/open-toolchain/hello-tekton.git",
"type": "GitHub",
"blind_connection": false,
"branch": "master",
"hook_id": "330377364",
"tool": {
"id": "74895ba2-d6c9-4216-8a3e-eb883ae655d6"
}
}
},
"events": [
"push",
"pull_request"
],
"enable_events_from_forks": false,
"disable_draft_events": false
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Trigger not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"name\": \"triggerName\" }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/1bb892a1-2e04-4768-a369-b1159eace147/duplicate\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"duplicateTektonPipelineTriggerOptions := cdTektonPipelineService.NewDuplicateTektonPipelineTriggerOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"1bb892a1-2e04-4768-a369-b1159eace147\",\n",
" \"triggerName\",\n",
")\n",
"\n",
"trigger, response, err := cdTektonPipelineService.DuplicateTektonPipelineTrigger(duplicateTektonPipelineTriggerOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(trigger, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" sourceTriggerId: '1bb892a1-2e04-4768-a369-b1159eace147',\n",
" name: 'triggerName',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.duplicateTektonPipelineTrigger(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.duplicate_tekton_pipeline_trigger(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" source_trigger_id='1bb892a1-2e04-4768-a369-b1159eace147',\n",
" name='triggerName',\n",
")\n",
"trigger = response.get_result()\n",
"\n",
"print(json.dumps(trigger, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"DuplicateTektonPipelineTriggerOptions duplicateTektonPipelineTriggerOptions = new DuplicateTektonPipelineTriggerOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .sourceTriggerId(\"1bb892a1-2e04-4768-a369-b1159eace147\")\n",
" .name(\"triggerName\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.duplicateTektonPipelineTrigger(duplicateTektonPipelineTriggerOptions).execute();\n",
"Trigger trigger = response.getResult();\n",
"\n",
"System.out.println(trigger);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/triggers/{trigger_id}/properties": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/triggerId"
}
],
"get": {
"tags": [
"Trigger properties"
],
"summary": "List trigger properties",
"description": "This request lists trigger properties for the trigger identified by `{trigger_id}`",
"operationId": "list_tekton_pipeline_trigger_properties",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.read"
}
]
},
"parameters": [
{
"name": "name",
"in": "query",
"description": "Filter properties by `name`",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
},
"example": "prod"
},
{
"name": "type",
"in": "query",
"description": "Filter properties by `type`. Valid types are `secure`, `text`, `integration`, `single_select`, `appconfig`",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
},
"example": "secure,text"
},
{
"name": "sort",
"in": "query",
"description": "Sort properties by name. They can be sorted in ascending order using `name` or in descending order using `-name`",
"required": false,
"schema": {
"$ref": "#/components/schemas/Query"
},
"example": "name"
}
],
"responses": {
"200": {
"description": "List of trigger properties",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerPropertiesCollection"
},
"example": {
"properties": [
{
"name": "ad123",
"value": "ad123-value",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/ad123"
}
]
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Trigger not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/1bb892a1-2e04-4768-a369-b1159eace147/properties?name=prod&type=secure,text&sort=name\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"listTektonPipelineTriggerPropertiesOptions := cdTektonPipelineService.NewListTektonPipelineTriggerPropertiesOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"1bb892a1-2e04-4768-a369-b1159eace147\",\n",
")\n",
"listTektonPipelineTriggerPropertiesOptions.SetName(\"prod\")\n",
"listTektonPipelineTriggerPropertiesOptions.SetType(\"secure,text\")\n",
"listTektonPipelineTriggerPropertiesOptions.SetSort(\"name\")\n",
"\n",
"triggerPropertiesCollection, response, err := cdTektonPipelineService.ListTektonPipelineTriggerProperties(listTektonPipelineTriggerPropertiesOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(triggerPropertiesCollection, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" triggerId: '1bb892a1-2e04-4768-a369-b1159eace147',\n",
" name: 'prod',\n",
" type: 'secure,text',\n",
" sort: 'name',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.listTektonPipelineTriggerProperties(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.list_tekton_pipeline_trigger_properties(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" trigger_id='1bb892a1-2e04-4768-a369-b1159eace147',\n",
" name='prod',\n",
" type='secure,text',\n",
" sort='name',\n",
")\n",
"trigger_properties_collection = response.get_result()\n",
"\n",
"print(json.dumps(trigger_properties_collection, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"ListTektonPipelineTriggerPropertiesOptions listTektonPipelineTriggerPropertiesOptions = new ListTektonPipelineTriggerPropertiesOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .triggerId(\"1bb892a1-2e04-4768-a369-b1159eace147\")\n",
" .name(\"prod\")\n",
" .type(\"secure,text\")\n",
" .sort(\"name\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.listTektonPipelineTriggerProperties(listTektonPipelineTriggerPropertiesOptions).execute();\n",
"TriggerPropertiesCollection triggerPropertiesCollection = response.getResult();\n",
"\n",
"System.out.println(triggerPropertiesCollection);"
]
}
]
}
]
}
}
},
"post": {
"tags": [
"Trigger properties"
],
"summary": "Create a trigger property",
"description": "This request creates a property in the trigger identified by `{trigger_id}`",
"operationId": "create_tekton_pipeline_trigger_properties",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerPropertyPrototype"
},
"examples": {
"text_env_property": {
"value": {
"name": "prop1",
"value": "https://github.com/open-toolchain/hello-tekton.git",
"type": "text"
}
},
"secure_env_property": {
"value": {
"name": "secret1",
"value": "C1V8amO0VYga5gD7PstC8mhnLi9iYVaWUb/CHLoFWGpSnf8c7LBwT4picQRBXlKa2WG5eEn534mB2eorKfetEw==",
"type": "secure"
}
},
"single_select_env_properties": {
"value": {
"name": "enums",
"type": "single_select",
"enum": [
"option1",
"option2",
"option3"
],
"value": "option1"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Trigger property added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerProperty"
},
"example": {
"name": "ad123",
"value": "ad123-value",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/ad123"
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Trigger not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"name\": \"prop1\", \"value\": \"https://github.com/open-toolchain/hello-tekton.git\", \"type\": \"text\" }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/1bb892a1-2e04-4768-a369-b1159eace147/properties\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"createTektonPipelineTriggerPropertiesOptions := cdTektonPipelineService.NewCreateTektonPipelineTriggerPropertiesOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"1bb892a1-2e04-4768-a369-b1159eace147\",\n",
" \"prop1\",\n",
" \"text\",\n",
")\n",
"createTektonPipelineTriggerPropertiesOptions.SetValue(\"https://github.com/open-toolchain/hello-tekton.git\")\n",
"\n",
"triggerProperty, response, err := cdTektonPipelineService.CreateTektonPipelineTriggerProperties(createTektonPipelineTriggerPropertiesOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(triggerProperty, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" triggerId: '1bb892a1-2e04-4768-a369-b1159eace147',\n",
" name: 'prop1',\n",
" type: 'text',\n",
" value: 'https://github.com/open-toolchain/hello-tekton.git',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.createTektonPipelineTriggerProperties(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.create_tekton_pipeline_trigger_properties(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" trigger_id='1bb892a1-2e04-4768-a369-b1159eace147',\n",
" name='prop1',\n",
" type='text',\n",
" value='https://github.com/open-toolchain/hello-tekton.git',\n",
")\n",
"trigger_property = response.get_result()\n",
"\n",
"print(json.dumps(trigger_property, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"CreateTektonPipelineTriggerPropertiesOptions createTektonPipelineTriggerPropertiesOptions = new CreateTektonPipelineTriggerPropertiesOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .triggerId(\"1bb892a1-2e04-4768-a369-b1159eace147\")\n",
" .name(\"prop1\")\n",
" .type(\"text\")\n",
" .value(\"https://github.com/open-toolchain/hello-tekton.git\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.createTektonPipelineTriggerProperties(createTektonPipelineTriggerPropertiesOptions).execute();\n",
"TriggerProperty triggerProperty = response.getResult();\n",
"\n",
"System.out.println(triggerProperty);"
]
}
]
}
]
}
}
}
},
"/tekton_pipelines/{pipeline_id}/triggers/{trigger_id}/properties/{property_name}": {
"parameters": [
{
"$ref": "#/components/parameters/pipelineId"
},
{
"$ref": "#/components/parameters/triggerId"
},
{
"$ref": "#/components/parameters/propertyName"
}
],
"get": {
"tags": [
"Trigger properties"
],
"summary": "Get a trigger property",
"description": "This request retrieves a trigger property",
"operationId": "get_tekton_pipeline_trigger_property",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.retrieve"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.read"
}
]
},
"responses": {
"200": {
"description": "Trigger property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerProperty"
},
"example": {
"name": "ad123",
"value": "ad123-value",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/ad123"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Trigger not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/1bb892a1-2e04-4768-a369-b1159eace147/properties/debug-pipeline\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"getTektonPipelineTriggerPropertyOptions := cdTektonPipelineService.NewGetTektonPipelineTriggerPropertyOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"1bb892a1-2e04-4768-a369-b1159eace147\",\n",
" \"debug-pipeline\",\n",
")\n",
"\n",
"triggerProperty, response, err := cdTektonPipelineService.GetTektonPipelineTriggerProperty(getTektonPipelineTriggerPropertyOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(triggerProperty, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" triggerId: '1bb892a1-2e04-4768-a369-b1159eace147',\n",
" propertyName: 'debug-pipeline',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.getTektonPipelineTriggerProperty(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.get_tekton_pipeline_trigger_property(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" trigger_id='1bb892a1-2e04-4768-a369-b1159eace147',\n",
" property_name='debug-pipeline',\n",
")\n",
"trigger_property = response.get_result()\n",
"\n",
"print(json.dumps(trigger_property, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"GetTektonPipelineTriggerPropertyOptions getTektonPipelineTriggerPropertyOptions = new GetTektonPipelineTriggerPropertyOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .triggerId(\"1bb892a1-2e04-4768-a369-b1159eace147\")\n",
" .propertyName(\"debug-pipeline\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.getTektonPipelineTriggerProperty(getTektonPipelineTriggerPropertyOptions).execute();\n",
"TriggerProperty triggerProperty = response.getResult();\n",
"\n",
"System.out.println(triggerProperty);"
]
}
]
}
]
}
}
},
"put": {
"tags": [
"Trigger properties"
],
"summary": "Replace a trigger property value",
"description": "This request updates a trigger property value, type and name are immutable",
"operationId": "replace_tekton_pipeline_trigger_property",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerPropertyPrototype"
},
"examples": {
"single_env_property": {
"value": {
"name": "prop1",
"value": "https://github.com/open-toolchain/hello-tekton.git",
"type": "text"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Edited trigger property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerProperty"
},
"example": {
"name": "prop1",
"value": "https://github.com/open-toolchain/hello-tekton.git",
"type": "text",
"href": "https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/properties/prop1"
}
}
}
},
"400": {
"description": "Malformed request syntax or invalid request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Trigger not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" --header \"Accept: application/json\" \\\n",
" --header \"Content-Type: application/json\" \\\n",
" --data '{ \"name\": \"prop1\", \"value\": \"https://github.com/open-toolchain/hello-tekton.git\", \"type\": \"text\" }' \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/1bb892a1-2e04-4768-a369-b1159eace147/properties/debug-pipeline\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"replaceTektonPipelineTriggerPropertyOptions := cdTektonPipelineService.NewReplaceTektonPipelineTriggerPropertyOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"1bb892a1-2e04-4768-a369-b1159eace147\",\n",
" \"debug-pipeline\",\n",
" \"prop1\",\n",
" \"text\",\n",
")\n",
"replaceTektonPipelineTriggerPropertyOptions.SetValue(\"https://github.com/open-toolchain/hello-tekton.git\")\n",
"\n",
"triggerProperty, response, err := cdTektonPipelineService.ReplaceTektonPipelineTriggerProperty(replaceTektonPipelineTriggerPropertyOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"b, _ := json.MarshalIndent(triggerProperty, \"\", \" \")\n",
"fmt.Println(string(b))"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" triggerId: '1bb892a1-2e04-4768-a369-b1159eace147',\n",
" propertyName: 'debug-pipeline',\n",
" name: 'prop1',\n",
" type: 'text',\n",
" value: 'https://github.com/open-toolchain/hello-tekton.git',\n",
"};\n",
"\n",
"let res;\n",
"try {\n",
" res = await cdTektonPipelineService.replaceTektonPipelineTriggerProperty(params);\n",
" console.log(JSON.stringify(res.result, null, 2));\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.replace_tekton_pipeline_trigger_property(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" trigger_id='1bb892a1-2e04-4768-a369-b1159eace147',\n",
" property_name='debug-pipeline',\n",
" name='prop1',\n",
" type='text',\n",
" value='https://github.com/open-toolchain/hello-tekton.git',\n",
")\n",
"trigger_property = response.get_result()\n",
"\n",
"print(json.dumps(trigger_property, indent=2))"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"ReplaceTektonPipelineTriggerPropertyOptions replaceTektonPipelineTriggerPropertyOptions = new ReplaceTektonPipelineTriggerPropertyOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .triggerId(\"1bb892a1-2e04-4768-a369-b1159eace147\")\n",
" .propertyName(\"debug-pipeline\")\n",
" .name(\"prop1\")\n",
" .type(\"text\")\n",
" .value(\"https://github.com/open-toolchain/hello-tekton.git\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.replaceTektonPipelineTriggerProperty(replaceTektonPipelineTriggerPropertyOptions).execute();\n",
"TriggerProperty triggerProperty = response.getResult();\n",
"\n",
"System.out.println(triggerProperty);"
]
}
]
}
]
}
}
},
"delete": {
"tags": [
"Trigger properties"
],
"summary": "Delete a trigger property",
"description": "This request deletes a trigger property",
"operationId": "delete_tekton_pipeline_trigger_property",
"x-ibm-permissions": {
"actions": [
{
"name": "toolchain.instance.update"
}
]
},
"x-ibm-events": {
"events": [
{
"name": "toolchain.pipeline.update"
}
]
},
"responses": {
"204": {
"description": "Property deleted"
},
"401": {
"description": "Authentication error or the IAM bearer token is missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"404": {
"description": "Trigger not found or authorization failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
},
"security": [
{
"iam_bearer_token": []
}
],
"x-sdk-operations": {
"request-examples": {
"curl": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n",
" \"https://api.us-south.devops.cloud.ibm.com/pipeline/v2/tekton_pipelines/94619026-912b-4d92-8f51-6c74f0692d90/triggers/1bb892a1-2e04-4768-a369-b1159eace147/properties/debug-pipeline\""
]
}
]
}
],
"go": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"deleteTektonPipelineTriggerPropertyOptions := cdTektonPipelineService.NewDeleteTektonPipelineTriggerPropertyOptions(\n",
" \"94619026-912b-4d92-8f51-6c74f0692d90\",\n",
" \"1bb892a1-2e04-4768-a369-b1159eace147\",\n",
" \"debug-pipeline\",\n",
")\n",
"\n",
"response, err := cdTektonPipelineService.DeleteTektonPipelineTriggerProperty(deleteTektonPipelineTriggerPropertyOptions)\n",
"if err != nil {\n",
" panic(err)\n",
"}\n",
"if response.StatusCode != 204 {\n",
" fmt.Printf(\"\\nUnexpected response status code received from DeleteTektonPipelineTriggerProperty(): %d\\n\", response.StatusCode)\n",
"}"
]
}
]
}
],
"node": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"const params = {\n",
" pipelineId: '94619026-912b-4d92-8f51-6c74f0692d90',\n",
" triggerId: '1bb892a1-2e04-4768-a369-b1159eace147',\n",
" propertyName: 'debug-pipeline',\n",
"};\n",
"\n",
"try {\n",
" await cdTektonPipelineService.deleteTektonPipelineTriggerProperty(params);\n",
"} catch (err) {\n",
" console.warn(err);\n",
"}"
]
}
]
}
],
"python": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"response = cd_tekton_pipeline_service.delete_tekton_pipeline_trigger_property(\n",
" pipeline_id='94619026-912b-4d92-8f51-6c74f0692d90',\n",
" trigger_id='1bb892a1-2e04-4768-a369-b1159eace147',\n",
" property_name='debug-pipeline',\n",
")"
]
}
]
}
],
"java": [
{
"name": "Example request",
"example": [
{
"type": "code",
"source": [
"DeleteTektonPipelineTriggerPropertyOptions deleteTektonPipelineTriggerPropertyOptions = new DeleteTektonPipelineTriggerPropertyOptions.Builder()\n",
" .pipelineId(\"94619026-912b-4d92-8f51-6c74f0692d90\")\n",
" .triggerId(\"1bb892a1-2e04-4768-a369-b1159eace147\")\n",
" .propertyName(\"debug-pipeline\")\n",
" .build();\n",
"\n",
"Response response = cdTektonPipelineService.deleteTektonPipelineTriggerProperty(deleteTektonPipelineTriggerPropertyOptions).execute();"
]
}
]
}
]
}
}
}
}
},
"components": {
"parameters": {
"pipelineId": {
"description": "The Tekton pipeline ID",
"in": "path",
"name": "pipeline_id",
"required": true,
"schema": {
"$ref": "#/components/schemas/Uuid"
},
"example": "94619026-912b-4d92-8f51-6c74f0692d90"
},
"id": {
"in": "path",
"name": "id",
"description": "ID of current instance",
"required": true,
"schema": {
"$ref": "#/components/schemas/Uuid"
},
"example": "94619026-912b-4d92-8f51-6c74f0692d90"
},
"pipelineRunId": {
"description": "The Tekton pipeline run ID",
"in": "path",
"name": "pipeline_run_id",
"required": true,
"schema": {
"$ref": "#/components/schemas/Uuid"
},
"example": "bf4b3abd-0c93-416b-911e-9cf42f1a1085"
},
"definitionId": {
"description": "The definition ID",
"in": "path",
"name": "definition_id",
"required": true,
"schema": {
"$ref": "#/components/schemas/Uuid"
},
"example": "94299034-d45f-4e9a-8ed5-6bd5c7bb7ada"
},
"propertyName": {
"description": "The property name",
"in": "path",
"name": "property_name",
"required": true,
"schema": {
"$ref": "#/components/schemas/PropertyName"
},
"example": "debug-pipeline"
},
"triggerId": {
"description": "The trigger ID",
"in": "path",
"name": "trigger_id",
"required": true,
"schema": {
"$ref": "#/components/schemas/Uuid"
},
"example": "1bb892a1-2e04-4768-a369-b1159eace147"
},
"sourceTriggerId": {
"description": "The ID of the trigger to duplicate",
"in": "path",
"name": "source_trigger_id",
"required": true,
"schema": {
"$ref": "#/components/schemas/Uuid"
},
"example": "1bb892a1-2e04-4768-a369-b1159eace147"
}
},
"schemas": {
"DefinitionsCollection": {
"description": "Pipeline definitions is a collection of individual definition entries, each entry consists of a repository URL, a repository path, and a branch or tag",
"required": [
"definitions"
],
"properties": {
"definitions": {
"description": "The list of all definitions in the pipeline",
"type": "array",
"minItems": 0,
"maxItems": 128,
"items": {
"$ref": "#/components/schemas/Definition"
}
}
}
},
"Definition": {
"description": "Tekton pipeline definition entry object, consisting of a repository url, a repository path and a branch or tag. The referenced repository URL must match the URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools. The branch or tag of the definition must match against a corresponding branch or tag in the chosen repository, and the path must match a subfolder in the repository",
"x-resource-name": "cd_tekton_pipeline_definition",
"x-data-source-name": "cd_tekton_pipeline_definition",
"x-resource-operations": {
"create": "create_tekton_pipeline_definition",
"read": "get_tekton_pipeline_definition",
"update": "replace_tekton_pipeline_definition",
"delete": "delete_tekton_pipeline_definition"
},
"x-data-source-operations": {
"read": "get_tekton_pipeline_definition"
},
"required": [
"id",
"source"
],
"properties": {
"source": {
"$ref": "#/components/schemas/DefinitionSource"
},
"href": {
"allOf": [
{
"$ref": "#/components/schemas/Href"
},
{
"description": "API URL for interacting with the definition"
}
]
},
"id": {
"$ref": "#/components/schemas/DefinitionID"
}
}
},
"DefinitionPrototype": {
"description": "Request body used to create or update a single definition entry. The source property must consist of a properties object containing a repository url, a repository path and a branch or tag",
"required": [
"source"
],
"properties": {
"source": {
"$ref": "#/components/schemas/DefinitionSource"
}
}
},
"PipelineRunPrototype": {
"description": "Request body used to trigger a Tekton pipeline run",
"properties": {
"description": {
"$ref": "#/components/schemas/RunDescription"
},
"trigger_name": {
"$ref": "#/components/schemas/TriggerName"
},
"trigger_properties": {
"$ref": "#/components/schemas/TriggerProperties"
},
"secure_trigger_properties": {
"$ref": "#/components/schemas/SecureTriggerProperties"
},
"trigger_headers": {
"$ref": "#/components/schemas/TriggerHeaders"
},
"trigger_body": {
"$ref": "#/components/schemas/TriggerBody"
},
"trigger": {
"$ref": "#/components/schemas/PipelineRunTrigger"
}
}
},
"PipelineRunTrigger": {
"description": "Trigger details passed when triggering a Tekton pipeline run",
"required": [
"name"
],
"properties": {
"name": {
"$ref": "#/components/schemas/TriggerName"
},
"properties": {
"$ref": "#/components/schemas/TriggerProperties"
},
"secure_properties": {
"$ref": "#/components/schemas/SecureTriggerProperties"
},
"headers": {
"$ref": "#/components/schemas/TriggerHeaders"
},
"body": {
"$ref": "#/components/schemas/TriggerBody"
}
}
},
"TriggerSourcePrototype": {
"description": "Source repository for a Git trigger. Only required for Git triggers. The referenced repository URL must match the URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools",
"required": [
"type",
"properties"
],
"properties": {
"type": {
"$ref": "#/components/schemas/SourceType"
},
"properties": {
"$ref": "#/components/schemas/TriggerSourcePropertiesPrototype"
}
}
},
"TriggerSource": {
"description": "Source repository for a Git trigger. Only required for Git triggers. The referenced repository URL must match the URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools",
"required": [
"type",
"properties"
],
"properties": {
"type": {
"$ref": "#/components/schemas/SourceType"
},
"properties": {
"$ref": "#/components/schemas/TriggerSourceProperties"
}
}
},
"DefinitionSource": {
"description": "Source repository containing the Tekton pipeline definition",
"required": [
"type",
"properties"
],
"properties": {
"type": {
"$ref": "#/components/schemas/SourceType"
},
"properties": {
"$ref": "#/components/schemas/DefinitionSourceProperties"
}
}
},
"PropertiesCollection": {
"description": "Pipeline properties object",
"required": [
"properties"
],
"properties": {
"properties": {
"description": "Pipeline properties list",
"type": "array",
"minItems": 0,
"maxItems": 1024,
"items": {
"$ref": "#/components/schemas/Property"
}
}
}
},
"TriggerPropertiesCollection": {
"description": "Trigger properties object",
"required": [
"properties"
],
"properties": {
"properties": {
"description": "Trigger properties list",
"type": "array",
"minItems": 0,
"maxItems": 1024,
"items": {
"$ref": "#/components/schemas/TriggerProperty"
}
}
}
},
"TriggerProperty": {
"description": "Trigger property object",
"x-resource-id": "name",
"x-resource-name": "cd_tekton_pipeline_trigger_property",
"x-data-source-name": "cd_tekton_pipeline_trigger_property",
"x-resource-operations": {
"create": "create_tekton_pipeline_trigger_properties",
"read": "get_tekton_pipeline_trigger_property",
"update": "replace_tekton_pipeline_trigger_property",
"delete": "delete_tekton_pipeline_trigger_property"
},
"x-data-source-operations": {
"read": "get_tekton_pipeline_trigger_property"
},
"required": [
"name",
"type"
],
"properties": {
"name": {
"$ref": "#/components/schemas/PropertyName"
},
"value": {
"maxLength": 4096,
"minLength": 0,
"pattern": "^(\\s|.)*$",
"type": "string",
"description": "Property value. Any string value is valid",
"x-terraform-diff-suppress": "flex.SuppressTriggerPropertyRawSecret"
},
"href": {
"allOf": [
{
"$ref": "#/components/schemas/Href"
},
{
"description": "API URL for interacting with the trigger property"
}
]
},
"enum": {
"description": "Options for `single_select` property type. Only needed for `single_select` property type",
"type": "array",
"minItems": 0,
"maxItems": 256,
"items": {
"$ref": "#/components/schemas/GeneralString"
}
},
"type": {
"type": "string",
"enum": [
"secure",
"text",
"integration",
"single_select",
"appconfig"
],
"description": "Property type",
"x-terraform-force-new": true
},
"path": {
"maxLength": 4096,
"minLength": 0,
"pattern": "^[-0-9a-zA-Z_.]*$",
"type": "string",
"description": "A dot notation path for `integration` type properties only, that selects a value from the tool integration. If left blank the full tool integration data will be used"
},
"locked": {
"description": "When true, this property cannot be overridden at runtime. Attempting to override it will result in run requests being rejected. The default is false.",
"type": "boolean"
}
}
},
"TriggerPropertyPrototype": {
"description": "Trigger property object used to create or edit a property in a trigger",
"required": [
"name",
"type"
],
"properties": {
"name": {
"$ref": "#/components/schemas/PropertyName"
},
"value": {
"maxLength": 4096,
"minLength": 0,
"pattern": "^(\\s|.)*$",
"type": "string",
"description": "Property value. Any string value is valid",
"x-terraform-diff-suppress": "flex.SuppressTriggerPropertyRawSecret"
},
"enum": {
"description": "Options for `single_select` property type. Only needed for `single_select` property type",
"type": "array",
"minItems": 0,
"maxItems": 256,
"items": {
"$ref": "#/components/schemas/GeneralString"
}
},
"type": {
"type": "string",
"enum": [
"secure",
"text",
"integration",
"single_select",
"appconfig"
],
"description": "Property type"
},
"path": {
"maxLength": 4096,
"minLength": 0,
"pattern": "^[-0-9a-zA-Z_.]*$",
"type": "string",
"description": "A dot notation path for `integration` type properties only, to select a value from the tool integration. If left blank the full tool integration data will be used"
},
"locked": {
"description": "When true, this property cannot be overridden at runtime. Attempting to override it will result in run requests being rejected. The default is false.",
"type": "boolean",
"default": false
}
}
},
"Property": {
"description": "Property object",
"x-resource-id": "name",
"x-resource-name": "cd_tekton_pipeline_property",
"x-data-source-name": "cd_tekton_pipeline_property",
"x-resource-operations": {
"create": "create_tekton_pipeline_properties",
"read": "get_tekton_pipeline_property",
"update": "replace_tekton_pipeline_property",
"delete": "delete_tekton_pipeline_property"
},
"x-data-source-operations": {
"read": "get_tekton_pipeline_property"
},
"required": [
"name",
"type"
],
"properties": {
"name": {
"$ref": "#/components/schemas/PropertyName"
},
"value": {
"maxLength": 4096,
"minLength": 0,
"pattern": "^(\\s|.)*$",
"type": "string",
"description": "Property value. Any string value is valid",
"x-terraform-diff-suppress": "flex.SuppressPipelinePropertyRawSecret"
},
"href": {
"allOf": [
{
"$ref": "#/components/schemas/Href"
},
{
"description": "API URL for interacting with the property"
}
]
},
"enum": {
"description": "Options for `single_select` property type. Only needed when using `single_select` property type",
"type": "array",
"minItems": 0,
"maxItems": 256,
"items": {
"$ref": "#/components/schemas/GeneralString"
}
},
"type": {
"type": "string",
"enum": [
"secure",
"text",
"integration",
"single_select",
"appconfig"
],
"description": "Property type",
"x-terraform-force-new": true
},
"locked": {
"description": "When true, this property cannot be overridden by a trigger property or at runtime. Attempting to override it will result in run requests being rejected. The default is false.",
"type": "boolean"
},
"path": {
"maxLength": 4096,
"minLength": 0,
"pattern": "^[-0-9a-zA-Z_.]*$",
"type": "string",
"description": "A dot notation path for `integration` type properties only, that selects a value from the tool integration. If left blank the full tool integration data will be used"
}
}
},
"PropertyPrototype": {
"description": "Property object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"$ref": "#/components/schemas/PropertyName"
},
"value": {
"maxLength": 4096,
"minLength": 0,
"pattern": "^(\\s|.)*$",
"type": "string",
"description": "Property value. Any string value is valid",
"x-terraform-diff-suppress": "flex.SuppressPipelinePropertyRawSecret"
},
"enum": {
"description": "Options for `single_select` property type. Only needed when using `single_select` property type",
"type": "array",
"minItems": 0,
"maxItems": 256,
"items": {
"$ref": "#/components/schemas/GeneralString"
}
},
"type": {
"type": "string",
"enum": [
"secure",
"text",
"integration",
"single_select",
"appconfig"
],
"description": "Property type"
},
"locked": {
"description": "When true, this property cannot be overridden by a trigger property or at runtime. Attempting to override it will result in run requests being rejected. The default is false.",
"type": "boolean",
"default": false
},
"path": {
"maxLength": 4096,
"minLength": 0,
"pattern": "^[-0-9a-zA-Z_.]*$",
"type": "string",
"description": "A dot notation path for `integration` type properties only, to select a value from the tool integration. If left blank the full tool integration data will be used"
}
}
},
"WorkerIdentity": {
"description": "Specify the worker that is to be used to run the trigger, indicated by a worker object with only the worker ID. If not specified or set as `worker: { id: 'public' }`, the IBM Managed shared workers are used.",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "ID of the worker",
"pattern": "^[-0-9a-zA-Z]{1,253}$",
"maxLength": 253,
"minLength": 1
}
}
},
"Worker": {
"description": "Details of the worker used to run the pipeline",
"required": [
"id"
],
"properties": {
"name": {
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_. \\(\\)\\[\\]]{1,253}$",
"type": "string",
"description": "Name of the worker. Computed based on the worker ID",
"x-terraform-computed": true
},
"type": {
"description": "Type of the worker. Computed based on the worker ID",
"type": "string",
"x-terraform-computed": true,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"maxLength": 253,
"minLength": 1
},
"id": {
"type": "string",
"pattern": "^[-0-9a-zA-Z]{1,36}$",
"maxLength": 36,
"minLength": 1,
"description": "ID of the worker"
}
}
},
"Events": {
"description": "Either 'events' or 'filter' is required specifically for Git triggers. Stores a list of events that a Git trigger listens to. Choose one or more from 'push', 'pull_request', and 'pull_request_closed'. If SCM repositories use the 'merge request' term, they correspond to the generic term i.e. 'pull request'",
"type": "array",
"minItems": 0,
"maxItems": 3,
"example": [
"push",
"pull_request"
],
"x-sdk-go-serialize-empty": true,
"x-terraform-diff-suppress": "flex.SuppressTriggerEvents",
"items": {
"$ref": "#/components/schemas/TriggerEvents"
}
},
"Filter": {
"description": "Either 'events' or 'filter' can be used. Stores the CEL (Common Expression Language) expression value which is used for event filtering against the Git webhook payloads",
"type": "string",
"pattern": "^.*$",
"minLength": 1,
"maxLength": 4096,
"example": "header['x-github-event'] == 'push' && body.ref == 'refs/heads/main'"
},
"WebhookFilter": {
"allOf": [
{
"$ref": "#/components/schemas/Filter"
},
{
"description": "Stores the CEL (Common Expression Language) expression value which is used for event filtering against the webhook payloads"
},
{
"minLength": 0
},
{
"example": "event.type == 'message' && event.text.contains('urgent')"
}
]
},
"DuplicateTrigger": {
"description": "Duplicate an existing trigger",
"required": [
"name"
],
"properties": {
"name": {
"$ref": "#/components/schemas/TriggerName"
}
}
},
"BaseTrigger": {
"description": "Trigger",
"required": [
"enabled",
"event_listener",
"id",
"name",
"type"
],
"properties": {
"type": {
"description": "Trigger type",
"type": "string",
"enum": [
"manual",
"scm",
"timer",
"generic"
]
},
"name": {
"$ref": "#/components/schemas/TriggerName"
},
"href": {
"allOf": [
{
"$ref": "#/components/schemas/Href"
},
{
"description": "API URL for interacting with the trigger. Only included when fetching the list of pipeline triggers"
}
]
},
"event_listener": {
"description": "Event listener name. The name of the event listener to which the trigger is associated. The event listeners are defined in the definition repositories of the Tekton pipeline",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string"
},
"id": {
"$ref": "#/components/schemas/TriggerID"
},
"properties": {
"description": "Optional trigger properties are used to override or supplement the pipeline properties when triggering a pipeline run",
"type": "array",
"minItems": 0,
"maxItems": 1024,
"items": {
"$ref": "#/components/schemas/TriggerProperty"
}
},
"tags": {
"description": "Optional trigger tags array",
"type": "array",
"minItems": 0,
"maxItems": 128,
"x-sdk-go-serialize-empty": true,
"items": {
"$ref": "#/components/schemas/GeneralString"
}
},
"worker": {
"allOf": [
{
"$ref": "#/components/schemas/Worker"
},
{
"description": "Details of the worker used to run the trigger"
}
]
},
"max_concurrent_runs": {
"$ref": "#/components/schemas/MaxConcurrentRuns"
},
"enabled": {
"description": "Flag to check if the trigger is enabled",
"type": "boolean",
"default": true
},
"favorite": {
"description": "Mark the trigger as a favorite",
"type": "boolean",
"default": false
},
"limit_waiting_runs": {
"description": "Flag that will limit the trigger to a maximum of one waiting run. A newly triggered run will cause any other waiting run(s) to be automatically cancelled",
"type": "boolean",
"default": false
}
}
},
"ManualTrigger": {
"allOf": [
{
"$ref": "#/components/schemas/BaseTrigger"
},
{
"description": "Manual trigger"
},
{
"properties": {
"type": {
"type": "string",
"description": "Trigger type",
"enum": [
"manual"
]
}
}
}
]
},
"ScmTrigger": {
"allOf": [
{
"$ref": "#/components/schemas/BaseTrigger"
},
{
"description": "Git trigger type. It automatically triggers a pipeline run when the Tekton Pipeline Service receives a corresponding Git webhook event"
},
{
"properties": {
"type": {
"type": "string",
"description": "Trigger type",
"enum": [
"scm"
]
},
"enable_events_from_forks": {
"description": "When enabled, pull request events from forks of the selected repository will trigger a pipeline run",
"type": "boolean",
"default": false
},
"disable_draft_events": {
"description": "Prevent new pipeline runs from being triggered by events from draft pull requests",
"type": "boolean",
"default": false
},
"source": {
"$ref": "#/components/schemas/TriggerSource"
},
"events": {
"$ref": "#/components/schemas/Events"
},
"filter": {
"$ref": "#/components/schemas/Filter"
}
}
}
]
},
"TimerTrigger": {
"allOf": [
{
"$ref": "#/components/schemas/BaseTrigger"
},
{
"description": "Timer trigger, which triggers pipeline runs according to the provided CRON value and timezone"
},
{
"properties": {
"type": {
"type": "string",
"description": "Trigger type",
"enum": [
"timer"
]
},
"cron": {
"description": "Only needed for timer triggers. CRON expression that indicates when this trigger will activate. Maximum frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day of month, month, day of week. Example: The CRON expression 0 */2 * * * - translates to - every 2 hours",
"maxLength": 253,
"minLength": 5,
"pattern": "^[-0-9a-zA-Z,\\*\\/ ]{5,253}$",
"type": "string"
},
"timezone": {
"allOf": [
{
"$ref": "#/components/schemas/TimeZone"
},
{
"description": "Only used for timer triggers. Specify the timezone used for this timer trigger, which will ensure the CRON activates this trigger relative to the specified timezone. If no timezone is specified, the default timezone used is UTC. Valid timezones are those listed in the IANA timezone database, https://www.iana.org/time-zones"
}
]
}
}
}
]
},
"GenericTrigger": {
"allOf": [
{
"$ref": "#/components/schemas/BaseTrigger"
},
{
"description": "Generic webhook trigger, which triggers a pipeline run when the Tekton Pipeline Service receives a POST event with secrets"
},
{
"properties": {
"type": {
"type": "string",
"description": "Trigger type",
"enum": [
"generic"
]
},
"secret": {
"$ref": "#/components/schemas/GenericSecret"
},
"webhook_url": {
"allOf": [
{
"$ref": "#/components/schemas/Href"
},
{
"description": "Webhook URL that can be used to trigger pipeline runs"
}
]
},
"filter": {
"$ref": "#/components/schemas/WebhookFilter"
}
}
}
]
},
"TriggerPrototype": {
"description": "Tekton pipeline trigger",
"required": [
"type",
"name",
"event_listener"
],
"properties": {
"type": {
"description": "Trigger type",
"type": "string",
"enum": [
"manual",
"scm",
"timer",
"generic"
]
},
"name": {
"$ref": "#/components/schemas/TriggerName"
},
"event_listener": {
"description": "Event listener name. The name of the event listener to which the trigger is associated. The event listeners are defined in the definition repositories of the Tekton pipeline",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string"
},
"tags": {
"description": "Trigger tags array",
"type": "array",
"minItems": 0,
"maxItems": 128,
"x-sdk-go-serialize-empty": true,
"items": {
"$ref": "#/components/schemas/GeneralString"
}
},
"worker": {
"allOf": [
{
"$ref": "#/components/schemas/WorkerIdentity"
},
{
"description": "Specify the worker used to run the trigger. Use `worker: { id: 'public' }` to use the IBM Managed workers. The default is to inherit the worker set in the pipeline settings, which can also be explicitly set using `worker: { id: 'inherit' }`"
}
]
},
"max_concurrent_runs": {
"$ref": "#/components/schemas/MaxConcurrentRuns"
},
"limit_waiting_runs": {
"description": "Flag that will limit the trigger to a maximum of one waiting run. A newly triggered run will cause any other waiting run(s) to be automatically cancelled",
"type": "boolean",
"default": false
},
"enabled": {
"description": "Flag to check if the trigger is enabled. If omitted the trigger is enabled by default",
"type": "boolean",
"default": true
},
"secret": {
"$ref": "#/components/schemas/GenericSecret"
},
"cron": {
"description": "Only needed for timer triggers. CRON expression that indicates when this trigger will activate. Maximum frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day of month, month, day of week. Example: The CRON expression 0 */2 * * * - translates to - every 2 hours",
"maxLength": 253,
"minLength": 5,
"pattern": "^[-0-9a-zA-Z,\\*\\/ ]{5,253}$",
"type": "string"
},
"timezone": {
"allOf": [
{
"$ref": "#/components/schemas/TimeZone"
},
{
"description": "Only used for timer triggers. Specify the timezone used for this timer trigger, which will ensure the CRON activates this trigger relative to the specified timezone. If no timezone is specified, the default timezone used is UTC. Valid timezones are those listed in the IANA timezone database, https://www.iana.org/time-zones"
}
]
},
"source": {
"$ref": "#/components/schemas/TriggerSourcePrototype"
},
"events": {
"$ref": "#/components/schemas/Events"
},
"filter": {
"$ref": "#/components/schemas/Filter"
},
"favorite": {
"description": "Mark the trigger as a favorite",
"type": "boolean",
"default": false
},
"enable_events_from_forks": {
"description": "Only used for SCM triggers. When enabled, pull request events from forks of the selected repository will trigger a pipeline run",
"type": "boolean",
"default": false
},
"disable_draft_events": {
"description": "Prevent new pipeline runs from being triggered by events from draft pull requests",
"type": "boolean",
"default": false
}
}
},
"Trigger": {
"description": "Tekton pipeline trigger",
"x-resource-name": "cd_tekton_pipeline_trigger",
"x-data-source-name": "cd_tekton_pipeline_trigger",
"x-resource-operations": {
"create": "create_tekton_pipeline_trigger",
"read": "get_tekton_pipeline_trigger",
"update": "update_tekton_pipeline_trigger",
"delete": "delete_tekton_pipeline_trigger"
},
"x-data-source-operations": {
"read": "get_tekton_pipeline_trigger"
},
"oneOf": [
{
"$ref": "#/components/schemas/ManualTrigger"
},
{
"$ref": "#/components/schemas/ScmTrigger"
},
{
"$ref": "#/components/schemas/TimerTrigger"
},
{
"$ref": "#/components/schemas/GenericTrigger"
}
]
},
"TriggerPatch": {
"description": "Tekton pipeline trigger object used for updating the trigger",
"properties": {
"type": {
"description": "Trigger type",
"type": "string",
"enum": [
"manual",
"scm",
"timer",
"generic"
]
},
"name": {
"$ref": "#/components/schemas/TriggerName"
},
"event_listener": {
"description": "Event listener name. The name of the event listener to which the trigger is associated. The event listeners are defined in the definition repositories of the Tekton pipeline",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string"
},
"tags": {
"description": "Trigger tags array. Optional tags for the trigger",
"type": "array",
"minItems": 0,
"maxItems": 128,
"x-sdk-go-serialize-empty": true,
"items": {
"$ref": "#/components/schemas/GeneralString"
}
},
"worker": {
"allOf": [
{
"$ref": "#/components/schemas/WorkerIdentity"
},
{
"description": "Specify the worker used to run the trigger. Use `worker: { id: 'public' }` to use the IBM Managed workers. Use `worker: { id: 'inherit' }` to inherit the worker used by the pipeline"
}
]
},
"max_concurrent_runs": {
"allOf": [
{
"$ref": "#/components/schemas/MaxConcurrentRuns"
},
{
"description": "Defines the maximum number of concurrent runs for this trigger. If set to 0 then the custom concurrency limit is disabled for this trigger"
}
]
},
"limit_waiting_runs": {
"description": "Flag that will limit the trigger to a maximum of one waiting run. A newly triggered run will cause any other waiting run(s) to be automatically cancelled",
"type": "boolean",
"default": false
},
"enabled": {
"description": "Defines if this trigger is enabled",
"type": "boolean"
},
"secret": {
"$ref": "#/components/schemas/GenericSecret"
},
"cron": {
"description": "Only needed for timer triggers. CRON expression that indicates when this trigger will activate. Maximum frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day of month, month, day of week. Example: The CRON expression 0 */2 * * * - translates to - every 2 hours",
"maxLength": 253,
"minLength": 5,
"pattern": "^[-0-9a-zA-Z,\\*\\/ ]{5,253}$",
"type": "string"
},
"timezone": {
"allOf": [
{
"$ref": "#/components/schemas/TimeZone"
},
{
"description": "Only used for timer triggers. Specify the timezone used for this timer trigger, which will ensure the CRON activates this trigger relative to the specified timezone. If no timezone is specified, the default timezone used is UTC. Valid timezones are those listed in the IANA timezone database, https://www.iana.org/time-zones"
}
]
},
"source": {
"$ref": "#/components/schemas/TriggerSourcePrototype"
},
"events": {
"$ref": "#/components/schemas/Events"
},
"filter": {
"$ref": "#/components/schemas/Filter"
},
"favorite": {
"description": "Mark the trigger as a favorite",
"type": "boolean",
"default": false
},
"enable_events_from_forks": {
"description": "Only used for SCM triggers. When enabled, pull request events from forks of the selected repository will trigger a pipeline run",
"type": "boolean",
"default": false
},
"disable_draft_events": {
"description": "Prevent new pipeline runs from being triggered by events from draft pull requests",
"type": "boolean",
"default": false
}
}
},
"TriggersCollection": {
"description": "Tekton pipeline triggers object",
"required": [
"triggers"
],
"properties": {
"triggers": {
"description": "Tekton pipeline triggers list",
"type": "array",
"minItems": 0,
"maxItems": 1024,
"items": {
"$ref": "#/components/schemas/Trigger"
}
}
}
},
"ToolchainReference": {
"description": "Toolchain object containing references to the parent toolchain",
"required": [
"id",
"crn"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"crn": {
"description": "The CRN for the toolchain that contains the Tekton pipeline",
"example": "crn:v1:staging:public:toolchain:us-south:a/0ba224679d6c697f9baee5e14ade83ac:bf5fa00f-ddef-4298-b87b-aa8b6da0e1a6::",
"maxLength": 512,
"minLength": 9,
"type": "string",
"format": "crn",
"pattern": "^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@/]|%[0-9A-Z]{2})*){8}$"
}
}
},
"ResourceGroupReference": {
"description": "The resource group in which the pipeline was created",
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
}
}
},
"TektonPipelinePrototype": {
"description": "Request body used to create a pipeline. Requires a pipeline tool already created in the toolchain using the toolchain API https://cloud.ibm.com/apidocs/toolchain#create-tool",
"required": [
"id"
],
"properties": {
"next_build_number": {
"description": "Specify the build number that will be used for the next pipeline run. Build numbers can be any positive whole number between 0 and 100000000000000.",
"type": "integer",
"minimum": 1,
"maximum": 99999999999999
},
"enable_notifications": {
"description": "Flag to enable notifications for this pipeline. If enabled, the Tekton pipeline run events will be published to all the destinations specified by the Slack and Event Notifications integrations in the parent toolchain.",
"type": "boolean",
"default": false
},
"enable_partial_cloning": {
"description": "Flag to enable partial cloning for this pipeline. When partial clone is enabled, only the files contained within the paths specified in definition repositories are read and cloned, this means that symbolic links might not work",
"type": "boolean",
"default": false
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "The ID for the associated pipeline tool, which was already created in the target toolchain. To get the pipeline ID call the toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools and find the pipeline tool"
}
]
},
"worker": {
"$ref": "#/components/schemas/WorkerIdentity"
}
}
},
"TektonPipelinePatch": {
"description": "Request body used to update this pipeline",
"properties": {
"next_build_number": {
"description": "Specify the build number that will be used for the next pipeline run. Build numbers can be any positive whole number between 0 and 100000000000000.",
"type": "integer",
"minimum": 1,
"maximum": 99999999999999
},
"enable_notifications": {
"description": "Flag to enable notifications for this pipeline. If enabled, the Tekton pipeline run events will be published to all the destinations specified by the Slack and Event Notifications integrations in the parent toolchain.",
"type": "boolean"
},
"enable_partial_cloning": {
"description": "Flag to enable partial cloning for this pipeline. When partial clone is enabled, only the files contained within the paths specified in definition repositories are read and cloned, this means that symbolic links might not work",
"type": "boolean"
},
"worker": {
"$ref": "#/components/schemas/WorkerIdentity"
}
}
},
"TektonPipeline": {
"description": "Tekton pipeline object",
"x-data-source-name": "cd_tekton_pipeline",
"x-resource-name": "cd_tekton_pipeline",
"x-resource-operations": {
"create": "create_tekton_pipeline",
"read": "get_tekton_pipeline",
"update": "update_tekton_pipeline",
"delete": "delete_tekton_pipeline"
},
"x-data-source-operations": {
"read": "get_tekton_pipeline"
},
"required": [
"build_number",
"created_at",
"definitions",
"enabled",
"enable_notifications",
"enable_partial_cloning",
"id",
"name",
"next_build_number",
"properties",
"resource_group",
"runs_url",
"status",
"toolchain",
"triggers",
"updated_at",
"worker"
],
"properties": {
"name": {
"$ref": "#/components/schemas/PipelineName"
},
"status": {
"description": "Pipeline status",
"type": "string",
"enum": [
"configured",
"configuring"
]
},
"resource_group": {
"$ref": "#/components/schemas/ResourceGroupReference"
},
"toolchain": {
"$ref": "#/components/schemas/ToolchainReference"
},
"id": {
"$ref": "#/components/schemas/Uuid"
},
"definitions": {
"description": "Definition list",
"type": "array",
"minItems": 0,
"maxItems": 128,
"items": {
"$ref": "#/components/schemas/Definition"
}
},
"properties": {
"description": "Tekton pipeline's environment properties",
"type": "array",
"minItems": 0,
"maxItems": 1024,
"items": {
"$ref": "#/components/schemas/Property"
}
},
"updated_at": {
"$ref": "#/components/schemas/DateTime"
},
"created_at": {
"$ref": "#/components/schemas/DateTime"
},
"triggers": {
"description": "Tekton pipeline triggers list",
"type": "array",
"minItems": 0,
"maxItems": 1024,
"items": {
"$ref": "#/components/schemas/Trigger"
}
},
"worker": {
"$ref": "#/components/schemas/Worker"
},
"runs_url": {
"maxLength": 2048,
"minLength": 10,
"pattern": "^http(s)?:\\/\\/([^\\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$",
"type": "string",
"description": "URL for this pipeline showing the list of pipeline runs"
},
"href": {
"allOf": [
{
"$ref": "#/components/schemas/Href"
},
{
"description": "API URL for interacting with the pipeline"
}
]
},
"build_number": {
"description": "The latest pipeline run build number. If this property is absent, the pipeline hasn't had any pipeline runs",
"type": "integer",
"minimum": 1
},
"next_build_number": {
"description": "The build number that will be used for the next pipeline run",
"type": "integer",
"minimum": 1,
"maximum": 99999999999999
},
"enable_notifications": {
"description": "Flag to enable notifications for this pipeline. If enabled, the Tekton pipeline run events will be published to all the destinations specified by the Slack and Event Notifications integrations in the parent toolchain. If omitted, this feature is disabled by default",
"type": "boolean"
},
"enable_partial_cloning": {
"description": "Flag to enable partial cloning for this pipeline. When partial clone is enabled, only the files contained within the paths specified in definition repositories are read and cloned, this means that symbolic links might not work. If omitted, this feature is disabled by default",
"type": "boolean"
},
"enabled": {
"description": "Flag to check if the trigger is enabled",
"type": "boolean",
"default": true
}
}
},
"CancelBody": {
"description": "Cancel a pipeline run. Include force option to force the pipeline run status to be 'cancelled' in case you can't cancel a pipeline run normally",
"properties": {
"force": {
"type": "boolean",
"description": "Flag indicating whether the pipeline cancellation action is forced or not"
}
}
},
"Status": {
"description": "Status of the pipeline run",
"type": "string",
"enum": [
"pending",
"waiting",
"queued",
"running",
"cancelled",
"failed",
"error",
"succeeded"
]
},
"UserInfo": {
"description": "Information about the user that triggered a pipeline run. Only included for pipeline runs that were manually triggered",
"required": [
"iam_id",
"sub"
],
"properties": {
"iam_id": {
"allOf": [
{
"$ref": "#/components/schemas/GeneralString"
},
{
"description": "IBM Cloud IAM ID"
}
]
},
"sub": {
"allOf": [
{
"$ref": "#/components/schemas/Email"
},
{
"description": "User email address"
}
]
}
}
},
"PipelineRunWorker": {
"description": "Worker details used in this pipeline run",
"required": [
"id"
],
"properties": {
"name": {
"$ref": "#/components/schemas/WorkerName"
},
"agent_id": {
"$ref": "#/components/schemas/AgentID"
},
"service_id": {
"$ref": "#/components/schemas/ServiceID"
},
"id": {
"$ref": "#/components/schemas/Uuid"
}
}
},
"PipelineRun": {
"description": "Single Tekton pipeline run object",
"required": [
"created_at",
"definition_id",
"event_params_blob",
"id",
"listener_name",
"pipeline_id",
"run_url",
"status",
"trigger",
"worker"
],
"properties": {
"id": {
"$ref": "#/components/schemas/Uuid"
},
"href": {
"$ref": "#/components/schemas/Href"
},
"user_info": {
"$ref": "#/components/schemas/UserInfo"
},
"status": {
"$ref": "#/components/schemas/Status"
},
"definition_id": {
"$ref": "#/components/schemas/DefinitionID"
},
"definition": {
"$ref": "#/components/schemas/RunDefinition"
},
"description": {
"$ref": "#/components/schemas/RunDescription"
},
"worker": {
"$ref": "#/components/schemas/PipelineRunWorker"
},
"pipeline_id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "The ID of the pipeline to which this pipeline run belongs"
}
]
},
"pipeline": {
"$ref": "#/components/schemas/RunPipeline"
},
"listener_name": {
"description": "Listener name used to start the run",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string"
},
"trigger": {
"$ref": "#/components/schemas/Trigger"
},
"event_params_blob": {
"type": "string",
"description": "Event parameters object in String format that was passed in upon creation of this pipeline run, the contents depends on the type of trigger. For example, the Git event payload is included for Git triggers, or in the case of a manual trigger the override and added properties are included",
"maxLength": 4096,
"minLength": 0,
"pattern": "^.*$"
},
"trigger_headers": {
"type": "string",
"description": "Trigger headers object in String format that was passed in upon creation of this pipeline run. Omitted if no trigger_headers object was provided when creating the pipeline run",
"maxLength": 4096,
"minLength": 0,
"pattern": "^.*$"
},
"properties": {
"type": "array",
"minItems": 0,
"maxItems": 1024,
"description": "Properties used in this Tekton pipeline run. Not included when fetching the list of pipeline runs",
"items": {
"$ref": "#/components/schemas/Property"
}
},
"created_at": {
"$ref": "#/components/schemas/DateTime"
},
"updated_at": {
"allOf": [
{
"$ref": "#/components/schemas/DateTime"
},
{
"description": "Standard RFC 3339 Date Time String. Only included if the run has been updated since it was created"
}
]
},
"run_url": {
"maxLength": 2048,
"minLength": 10,
"pattern": "^http(s)?:\\/\\/([^\\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$",
"type": "string",
"description": "URL for the details page of this pipeline run"
},
"error_message": {
"type": "string",
"description": "Error message that provides details when a pipeline run encounters an error",
"maxLength": 4096,
"minLength": 0,
"pattern": "^.*$"
}
}
},
"PipelineRunsCollection": {
"description": "Tekton pipeline runs object",
"required": [
"pipeline_runs",
"limit",
"first"
],
"properties": {
"pipeline_runs": {
"description": "Tekton pipeline runs list",
"type": "array",
"minItems": 0,
"maxItems": 1024,
"items": {
"$ref": "#/components/schemas/PipelineRun"
}
},
"limit": {
"example": 20,
"format": "int32",
"maximum": 100,
"minimum": 1,
"type": "integer",
"description": "The number of pipeline runs to return, sorted by creation time, most recent first"
},
"first": {
"$ref": "#/components/schemas/RunsFirstPage"
},
"next": {
"$ref": "#/components/schemas/RunsNextPage"
},
"last": {
"$ref": "#/components/schemas/RunsLastPage"
}
}
},
"GenericSecret": {
"description": "Only needed for Generic Webhook trigger type. The secret is used to start the Generic Webhook trigger",
"properties": {
"type": {
"type": "string",
"enum": [
"token_matches",
"digest_matches",
"internal_validation"
],
"description": "Secret type"
},
"value": {
"type": "string",
"maxLength": 4096,
"minLength": 0,
"pattern": "^.*$",
"description": "Secret value, not needed if secret type is `internal_validation`",
"x-terraform-diff-suppress": "flex.SuppressGenericWebhookRawSecret"
},
"source": {
"type": "string",
"enum": [
"header",
"payload",
"query"
],
"description": "Secret location, not needed if secret type is `internal_validation`"
},
"key_name": {
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string",
"description": "Secret name, not needed if type is `internal_validation`"
},
"algorithm": {
"type": "string",
"enum": [
"md4",
"md5",
"sha1",
"sha256",
"sha384",
"sha512",
"sha512_224",
"sha512_256",
"ripemd160"
],
"description": "Algorithm used for `digest_matches` secret type. Only needed for `digest_matches` secret type"
}
}
},
"TriggerSourcePropertiesPrototype": {
"description": "Properties of the source, which define the URL of the repository and a branch or pattern",
"required": [
"url"
],
"properties": {
"url": {
"$ref": "#/components/schemas/TriggerSourceURL"
},
"branch": {
"allOf": [
{
"$ref": "#/components/schemas/GeneralString"
},
{
"description": "Name of a branch from the repo. Only one of branch, pattern, or filter should be specified"
}
]
},
"pattern": {
"maxLength": 253,
"minLength": 1,
"description": "The pattern of Git branch or tag. You can specify a glob pattern such as '!test' or '*master' to match against multiple tags or branches in the repository. The glob pattern used must conform to Bash 4.3 specifications, see bash documentation for more info: https://www.gnu.org/software/bash/manual/bash.html#Pattern-Matching. Only one of branch, pattern, or filter should be specified",
"pattern": "^[-0-9a-zA-Z_.:@=$&^\\/\\?\\!\\*\\+\\[\\]\\(\\)\\{\\}\\|\\\\]*$",
"type": "string"
}
}
},
"TriggerSourceProperties": {
"description": "Properties of the source, which define the URL of the repository and a branch or pattern",
"required": [
"blind_connection",
"tool",
"url"
],
"properties": {
"url": {
"$ref": "#/components/schemas/TriggerSourceURL"
},
"branch": {
"allOf": [
{
"$ref": "#/components/schemas/GeneralString"
},
{
"description": "Name of a branch from the repo. Only one of branch, pattern, or filter should be specified"
}
]
},
"pattern": {
"maxLength": 253,
"minLength": 1,
"description": "The pattern of Git branch or tag. You can specify a glob pattern such as '!test' or '*master' to match against multiple tags or branches in the repository. The glob pattern used must conform to Bash 4.3 specifications, see bash documentation for more info: https://www.gnu.org/software/bash/manual/bash.html#Pattern-Matching. Only one of branch, pattern, or filter should be specified",
"pattern": "^[-0-9a-zA-Z_.:@=$&^\\/\\?\\!\\*\\+\\[\\]\\(\\)\\{\\}\\|\\\\]*$",
"type": "string"
},
"blind_connection": {
"description": "True if the repository server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide",
"x-terraform-computed": true,
"type": "boolean"
},
"hook_id": {
"$ref": "#/components/schemas/HookID"
},
"tool": {
"$ref": "#/components/schemas/Tool"
}
}
},
"DefinitionSourceProperties": {
"description": "Properties of the source, which define the URL of the repository and a branch or tag",
"required": [
"url",
"path"
],
"properties": {
"url": {
"$ref": "#/components/schemas/DefinitionSourceURL"
},
"branch": {
"maxLength": 253,
"minLength": 1,
"description": "A branch from the repo, specify one of branch or tag only",
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string"
},
"tag": {
"maxLength": 253,
"minLength": 1,
"description": "A tag from the repo, specify one of branch or tag only",
"pattern": "^[-0-9a-zA-Z_]{1,253}$",
"type": "string"
},
"path": {
"maxLength": 253,
"minLength": 1,
"description": "The path to the definition's YAML files",
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string"
},
"tool": {
"$ref": "#/components/schemas/Tool"
}
}
},
"Uuid": {
"maxLength": 36,
"minLength": 36,
"pattern": "^[-0-9a-z]+$",
"type": "string",
"title": "UUID",
"description": "Universally Unique Identifier"
},
"Id": {
"maxLength": 64,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_]+$",
"type": "string",
"title": "ID",
"description": "ID"
},
"AgentID": {
"description": "The agent ID of the corresponding private worker integration used for this pipeline run",
"maxLength": 36,
"minLength": 36,
"pattern": "^[-0-9a-z]+$",
"type": "string",
"title": "Agent ID",
"x-terraform-computed": true
},
"ServiceID": {
"description": "The Service ID of the corresponding private worker integration used for this pipeline run",
"maxLength": 64,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_]+$",
"type": "string",
"title": "Service ID",
"x-terraform-computed": true
},
"DefinitionID": {
"description": "The aggregated definition ID",
"maxLength": 36,
"minLength": 36,
"pattern": "^[-0-9a-z]+$",
"type": "string",
"title": "Definition ID",
"x-terraform-computed": true
},
"TriggerID": {
"description": "The Trigger ID",
"maxLength": 36,
"minLength": 36,
"pattern": "^[-0-9a-z]+$",
"type": "string",
"title": "Trigger ID",
"x-terraform-computed": true
},
"HookID": {
"description": "Repository webhook ID. It is generated upon trigger creation",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string",
"title": "Hook ID",
"x-terraform-computed": true
},
"ToolID": {
"description": "ID of the repository tool instance in the parent toolchain",
"maxLength": 36,
"minLength": 36,
"pattern": "^[-0-9a-z]+$",
"type": "string",
"title": "Tool ID",
"x-terraform-computed": true
},
"DateTime": {
"maxLength": 24,
"minLength": 20,
"format": "date-time",
"type": "string",
"title": "Date Time String",
"description": "Standard RFC 3339 Date Time String",
"x-terraform-computed": true
},
"Query": {
"description": "Query in URL",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_,]+$",
"type": "string"
},
"Email": {
"description": "Email address",
"maxLength": 253,
"minLength": 1,
"pattern": "^.+@[^@]+\\.[^@]{2,}$",
"type": "string"
},
"GeneralString": {
"description": "String",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string"
},
"PipelineName": {
"description": "String",
"maxLength": 253,
"minLength": 1,
"pattern": "^[a-zA-Z0-9][-0-9a-zA-Z_. ]{1,251}[a-zA-Z0-9]$",
"type": "string"
},
"TriggerName": {
"maxLength": 253,
"minLength": 1,
"pattern": "^([a-zA-Z0-9]{1,2}|[a-zA-Z0-9][0-9a-zA-Z-_.: \\/\\(\\)\\[\\]]{1,251}[a-zA-Z0-9])$",
"type": "string",
"description": "Trigger name",
"example": "start-deploy"
},
"WorkerName": {
"description": "Name of the worker. Computed based on the worker ID",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string",
"x-terraform-computed": true
},
"TriggerProperties": {
"description": "An object containing string values only. It provides additional 'text' properties or overrides existing pipeline/trigger properties that can be used in the created run",
"type": "object",
"additionalProperties": true
},
"SecureTriggerProperties": {
"description": "An object containing string values only. It provides additional `secure` properties or overrides existing `secure` pipeline/trigger properties that can be used in the created run",
"type": "object",
"additionalProperties": true
},
"TriggerHeaders": {
"description": "An object containing string values only that provides the request headers. Use `$(header.header_key_name)` to access it in a TriggerBinding. Most commonly used as part of a Generic Webhook to provide a verification token or signature in the request headers",
"type": "object",
"additionalProperties": true
},
"TriggerBody": {
"description": "An object that provides the request body. Use `$(body.body_key_name)` to access it in a TriggerBinding. Most commonly used to pass in additional properties or override properties for the pipeline run that is created",
"type": "object",
"additionalProperties": true
},
"Tool": {
"description": "Reference to the repository tool in the parent toolchain",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/ToolID"
}
},
"type": "object",
"x-terraform-computed": true
},
"SourceType": {
"description": "The only supported source type is \"git\", indicating that the source is a git repository",
"maxLength": 253,
"minLength": 1,
"pattern": "^git$",
"type": "string"
},
"PropertyName": {
"description": "Property name",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_.]{1,253}$",
"type": "string",
"x-terraform-force-new": true
},
"PropertyType": {
"description": "Type of property",
"enum": [
"secure",
"text",
"integration",
"single_select",
"appconfig"
],
"type": "string"
},
"RunDefinition": {
"description": "Reference to the pipeline definition of a pipeline run",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "The ID of the definition used for a pipeline run"
}
]
}
},
"type": "object"
},
"RunDescription": {
"description": "Optional description for the created PipelineRun",
"maxLength": 300,
"minLength": 0,
"pattern": "^[\\S\\s]*$",
"type": "string"
},
"RunPipeline": {
"description": "Reference to the pipeline to which a pipeline run belongs",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "The ID of the pipeline to which a pipeline run belongs"
}
]
}
},
"type": "object"
},
"RunStatus": {
"description": "The status of a pipeline run. Pending: Pipeline run is requested. Running: Pipeline run is running on the cluster. Succeeded: Pipeline run successfully completed on the cluster. Failed: Pipeline run failed; review the log file for the run to determine the cause. Queued: Pipeline run is accepted for processing and runs when worker capacity is available. Waiting: Pipeline run is waiting to be queued. Cancelled: Pipeline run was cancelled by the system or by the user; the system cancels Pipeline run when the number of waiting runs exceeds the allowed limit. Error: Pipeline run contains errors that prevented it from being applied on the cluster.",
"enum": [
"pending",
"waiting",
"queued",
"running",
"cancelled",
"failed",
"error",
"succeeded"
],
"example": "succeeded",
"type": "string"
},
"RunIncludes": {
"description": "Include additional data in the fetch pipeline run request",
"enum": [
"definitions"
],
"type": "string"
},
"RunsFirstPage": {
"description": "First page of pipeline runs",
"required": [
"href"
],
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
}
},
"type": "object"
},
"RunsNextPage": {
"description": "Next page of pipeline runs relative to the `start` and `limit` params. Only included when there are more pages available",
"required": [
"href"
],
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
}
},
"type": "object"
},
"RunsLastPage": {
"description": "Last page of pipeline runs relative to the `start` and `limit` params. Only included when the last page has been reached",
"required": [
"href"
],
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
}
},
"type": "object"
},
"TriggerEvents": {
"description": "List of events. Supported options are 'push' Git webhook events, 'pull_request_closed' Git webhook events and 'pull_request' for 'open pull request' or 'update pull request' Git webhook events",
"enum": [
"push",
"pull_request",
"pull_request_closed"
]
},
"TriggerSourceURL": {
"description": "URL of the repository to which the trigger is listening",
"maxLength": 2048,
"minLength": 10,
"pattern": "^http(s)?:\\/\\/([^\\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$",
"type": "string",
"x-terraform-force-new": true
},
"DefinitionSourceURL": {
"description": "URL of the definition repository",
"maxLength": 2048,
"minLength": 10,
"pattern": "^http(s)?:\\/\\/([^\\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$",
"type": "string",
"x-terraform-force-new": true
},
"Href": {
"description": "General href URL",
"maxLength": 2048,
"minLength": 10,
"pattern": "^http(s)?:\\/\\/([^\\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$",
"type": "string",
"x-terraform-computed": true
},
"MaxConcurrentRuns": {
"description": "Defines the maximum number of concurrent runs for this trigger. If omitted then the concurrency limit is disabled for this trigger",
"type": "integer",
"example": 4,
"format": "int32"
},
"TimeZone": {
"description": "Timezone string value. Valid timezones are those listed in the IANA timezone database, https://www.iana.org/time-zones",
"type": "string",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z+_., /]{1,253}$",
"example": "America/Los_Angeles, CET, Europe/London, GMT, US/Eastern, or UTC"
},
"Error": {
"description": "Error object",
"properties": {
"code": {
"description": "A snake case string succinctly identifying the problem",
"example": "missing_field",
"maxLength": 253,
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(_[a-z0-9]+)*$",
"type": "string",
"enum": [
"ambiguous_body",
"creation_failure",
"git_toolchain_instance_not_found",
"immutable_field",
"internal_error",
"invalid_payload",
"invalid_query",
"invalid_query_offset",
"invalid_url",
"invalid_uuid",
"missing_field",
"no_content",
"non_unique_property_name",
"non_unique_value",
"not_found",
"not_found_property",
"pipeline_disabled",
"property_override_validation_toolchain_error",
"source_trigger_not_found",
"trigger_not_found",
"unacceptable_content_type",
"unacceptable_integration",
"unacceptable_locked_environment_property_override",
"unacceptable_locked_trigger_property_override",
"unacceptable_property_name",
"unacceptable_secure_environment_property_override",
"unacceptable_secure_property_override",
"unacceptable_secure_trigger_property_override",
"unacceptable_single_select",
"unacceptable_trigger_filter",
"unacceptable_value",
"unauthorized",
"unexpected_payload",
"unknown_event_type",
"unknown_generic_algorithm",
"unknown_generic_source",
"unknown_generic_type",
"unknown_property_type",
"unknown_toolchain_id",
"unknown_trigger_type",
"unknown_worker_id",
"unrecognized_key",
"wrong_path"
]
},
"message": {
"description": "An explanation of the problem",
"example": "The `zone.name` field is required.",
"type": "string",
"maxLength": 4096,
"minLength": 0,
"pattern": "^.*$"
},
"more_info": {
"description": "Link to API documentation",
"example": "https://console.bluemix.net/docs/iaas/instances.html#template",
"maxLength": 2048,
"minLength": 10,
"pattern": "^http(s)?:\\/\\/([^\\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$",
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"title": "Error"
},
"ErrorContainerModel": {
"description": "List of errors",
"properties": {
"errors": {
"description": "Array of errors",
"items": {
"$ref": "#/components/schemas/Error"
},
"type": "array",
"minItems": 0,
"maxItems": 128
},
"trace": {
"description": "Unique error identifier",
"example": "b1fd1314d09b7aced81414f8f0f30f9a",
"maxLength": 64,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_]+$",
"type": "string"
}
},
"required": [
"errors",
"trace"
],
"type": "object",
"title": "ErrorContainerModel"
},
"StepLog": {
"description": "Logs for a Tekton pipeline run step",
"required": [
"data",
"id"
],
"properties": {
"data": {
"type": "string",
"description": "The raw log content of the step. Only included when fetching an individual log object",
"pattern": "^[\\S\\s]*$",
"maxLength": 16777216,
"minLength": 0
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "Step log ID"
}
]
}
}
},
"Log": {
"description": "Log data for Tekton pipeline run steps",
"required": [
"id",
"name"
],
"properties": {
"href": {
"allOf": [
{
"$ref": "#/components/schemas/Href"
},
{
"description": "API for getting log content"
}
]
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Uuid"
},
{
"description": "Step log ID"
}
]
},
"name": {
"description": "/ of this log",
"maxLength": 253,
"minLength": 1,
"pattern": "^[-0-9a-zA-Z_./]{1,253}$",
"type": "string"
}
}
},
"LogsCollection": {
"description": "List of pipeline run log objects",
"required": [
"logs"
],
"properties": {
"logs": {
"type": "array",
"description": "The list of pipeline run log objects",
"minItems": 0,
"maxItems": 1024,
"items": {
"$ref": "#/components/schemas/Log"
}
}
}
}
},
"responses": {
"RateLimit": {
"description": "Too many requests have been made within a given time window.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorContainerModel"
}
}
}
}
},
"securitySchemes": {
"iam_bearer_token": {
"type": "http",
"scheme": "bearer"
}
}
}
}