diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-02-16 21:09:24 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-02-16 21:09:24 +0300 |
| commit | 1eec6b22b26d09ce6927adf66f98d755a6339815 (patch) | |
| tree | b1bb8bbdc0d49136bfd176a1e64d3bd9f2969396 /doc/api/jobs.md | |
| parent | b4e854a900ba9bcbfc3476f88317c59ea048daaf (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/jobs.md')
| -rw-r--r-- | doc/api/jobs.md | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/api/jobs.md b/doc/api/jobs.md index 2c935b6e288..18d2e5ec3df 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -154,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" @@ -260,7 +261,6 @@ Example of response "status": "pending" }, "ref": "master", - "artifacts": [], "runner": null, "stage": "test", "status": "failed", @@ -290,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. |