#32340 - Include mention of "manual" scope in jobs api doc

57211885 · Zac Sturgess · Rémy Coutable · 0bc2fef9 · 57211885 · 57211885
Commit 57211885 authored May 16, 2017 by Zac Sturgess Committed by Rémy Coutable May 16, 2017
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 2 deletions

changelogs/unreleased/32340-correct-jobs-api-documentation changelogs/unreleased/32340-correct-jobs-api-documentation +4 -0

doc/api/jobs.md doc/api/jobs.md +2 -2

No files found.
--- a/changelogs/unreleased/32340-correct-jobs-api-documentation
+++ b/changelogs/unreleased/32340-correct-jobs-api-documentation
+---
+title: "Correction to documention for manual steps on the Jobs API"
+merge_request: 11411
+author: Zac Sturgess
\ No newline at end of file
--- a/doc/api/jobs.md
+++ b/doc/api/jobs.md
@@ -11,7 +11,7 @@ GET /projects/:id/jobs
 | Attribute | Type    | Required | Description         |
 |-----------|---------|----------|---------------------|
 | `id`      | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
-| `scope`   | string **or** array of strings | no | The scope of jobs to show, one or array of: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`; showing all jobs if none provided |
+| `scope`   | string **or** array of strings | no | The scope of jobs to show, one or array of: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, `manual`; showing all jobs if none provided |

 ```
 curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" 'https://gitlab.example.com/api/v4/projects/1/jobs?scope[]=pending&scope[]=running'
@@ -125,7 +125,7 @@ GET /projects/:id/pipelines/:pipeline_id/jobs
 |---------------|--------------------------------|----------|----------------------|
 | `id`          | integer/string                        | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user  |
 | `pipeline_id` | integer                        | yes      | The ID of a pipeline |
-| `scope`       | string **or** array of strings | no       | The scope of jobs to show, one or array of: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`; showing all jobs if none provided |
+| `scope`       | string **or** array of strings | no       | The scope of jobs to show, one or array of: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, `manual`; showing all jobs if none provided |

 ```
 curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" 'https://gitlab.example.com/api/v4/projects/1/pipelines/6/jobs?scope[]=pending&scope[]=running'