Updating Details of a YAML Pipeline

domain_id

Yes

String

Definition:

Tenant ID, which can be obtained from the API credential on the console. The account ID is the tenant ID.

Constraints:

N/A

Value range:

The value contains 32 characters.

Default value:

N/A

pipeline_id

Yes

String

Definition:

Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including only digits and letters.

Default value:

N/A

project_id

No

String

Definition:

32-character UUID of a CodeArts project, which must be unique.

Constraints:

N/A

Value range:

The value contains 32 characters.

Default value:

N/A

name

No

String

Definition:

Pipeline name.

Constraints:

The pipeline name must be unique.

Value range:

Enter 1 to 128 characters, including only letters, digits, hyphens (-), and underscores (_).

Default value:

N/A

description

No

String

Definition:

Pipeline description.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

push_to_repo

No

Boolean

Definition:

Whether to push the code to a repository.

Constraints:

N/A

Value range:

• true: Push the code to a repository.

• false: Do not push the code to a repository.

Default value:

false

new_branch

No

Boolean

Definition:

Whether to use a new branch.

Constraints:

N/A

Value range:

• true: Use a new branch.

• false: Do not use a new branch.

Default value:

true

new_file

No

Boolean

Definition:

Whether to create a file.

Constraints:

N/A

Value range:

• true: Create a file.

• false: Do not create a file.

Default value:

true

file_content

No

String

Definition:

File content.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

selected_branch

No

String

Definition:

Selected branch.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

push_branch

No

String

Definition:

Name of the branch to be pushed.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

commit_message

No

String

Definition:

Commit message.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

create_pull_request

No

Boolean

Definition:

Whether to create a pull request.

Constraints:

N/A

Value range:

• true: Create a pull request.

• false: Do not create a pull request.

Default value:

true

agency_name

No

String

Definition:

Delegate URN, which is configured in the basic pipeline information and can be obtained from CodeArts IAM.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

pipeline_id

String

Definition:

Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including only digits and letters.

Default value:

N/A

200

OK