diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-30 21:10:09 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-30 21:10:09 +0300 |
| commit | d899d2a373f8be3d94760299faafa19c3c432c1e (patch) | |
| tree | c4648e948c6f8c5428bc0e0046b1dc2200e00402 /doc/api/jobs.md | |
| parent | 69d28d313c2a65ead87229841a50bfc130e8c952 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/jobs.md')
| -rw-r--r-- | doc/api/jobs.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/jobs.md b/doc/api/jobs.md index 375d52c3c58..6647b53bcb4 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -160,7 +160,7 @@ 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. | +| `pipeline_id` | integer | yes | ID of a pipeline. Can also be obtained in CI jobs via the [predefined CI variable](../ci/variables/predefined_variables.md) `CI_PIPELINE_ID`. | | `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. | |