diff options
Diffstat (limited to 'doc/api/jobs.md')
| -rw-r--r-- | doc/api/jobs.md | 33 |
1 files changed, 27 insertions, 6 deletions
diff --git a/doc/api/jobs.md b/doc/api/jobs.md index b7b742ebe66..18d2e5ec3df 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -54,6 +54,9 @@ Example of response {"file_type": "junit", "size": 750, "filename": "junit.xml.gz", "file_format": "gzip"} ], "artifacts_expire_at": "2016-01-23T17:54:27.895Z", + "tag_list": [ + "docker runner", "ubuntu18" + ], "id": 7, "name": "teaspoon", "pipeline": { @@ -104,6 +107,9 @@ Example of response "finished_at": "2015-12-24T17:54:24.921Z", "duration": 0.192, "artifacts_expire_at": "2016-01-23T17:54:24.921Z", + "tag_list": [ + "docker runner", "win10-2004" + ], "id": 6, "name": "rspec:other", "pipeline": { @@ -148,11 +154,12 @@ Get a list of jobs for a pipeline. GET /projects/:id/pipelines/:pipeline_id/jobs ``` -| Attribute | Type | Required | Description | -|---------------|--------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `pipeline_id` | integer | yes | ID of a pipeline. | -| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. | +| Attribute | Type | Required | Description | +|-------------------|--------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `pipeline_id` | integer | yes | ID of a pipeline. | +| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. | +| `include_retried` | boolean | no | Include retried jobs in the response. Defaults to `false`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/272627) in GitLab 13.9. | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines/6/jobs?scope[]=pending&scope[]=running" @@ -179,6 +186,9 @@ Example of response "finished_at": "2015-12-24T17:54:24.921Z", "duration": 0.192, "artifacts_expire_at": "2016-01-23T17:54:24.921Z", + "tag_list": [ + "docker runner", "ubuntu18" + ], "id": 6, "name": "rspec:other", "pipeline": { @@ -239,6 +249,9 @@ Example of response {"file_type": "junit", "size": 750, "filename": "junit.xml.gz", "file_format": "gzip"} ], "artifacts_expire_at": "2016-01-23T17:54:27.895Z", + "tag_list": [ + "docker runner", "ubuntu18" + ], "id": 7, "name": "teaspoon", "pipeline": { @@ -248,7 +261,6 @@ Example of response "status": "pending" }, "ref": "master", - "artifacts": [], "runner": null, "stage": "test", "status": "failed", @@ -278,6 +290,12 @@ Example of response In GitLab 13.3 and later, this endpoint [returns data for any pipeline](pipelines.md#single-pipeline-requests) including [child pipelines](../ci/parent_child_pipelines.md). +In GitLab 13.5 and later, this endpoint does not return retried jobs in the response +by default. + +In GitLab 13.9 and later, this endpoint can include retried jobs in the response +with `include_retried` set to `true`. + ## List pipeline bridges Get a list of bridge jobs for a pipeline. @@ -399,6 +417,9 @@ Example of response "finished_at": "2015-12-24T17:54:31.198Z", "duration": 0.465, "artifacts_expire_at": "2016-01-23T17:54:31.198Z", + "tag_list": [ + "docker runner", "macos-10.15" + ], "id": 8, "name": "rubocop", "pipeline": { |