diff options
| author | Alexis Reigel <alexis.reigel.ext@siemens.com> | 2018-06-11 15:25:39 +0200 |
|---|---|---|
| committer | Alexis Reigel <alexis.reigel.ext@siemens.com> | 2018-09-15 21:39:27 +0200 |
| commit | dc1e0f6bd835536702948dd84cd2addf9f293ab9 (patch) | |
| tree | 6f24c1367d3ea64a40bc64bb459c829600a723d5 | |
| parent | 641012c6383a1facf79b1c57a7163cb519b477de (diff) | |
| download | gitlab-ce-dc1e0f6bd835536702948dd84cd2addf9f293ab9.tar.gz | |
deprecate scope param for runners api
| -rw-r--r-- | doc/api/runners.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/runners.md b/doc/api/runners.md index 54568607a87..71ecb6606c1 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -17,7 +17,7 @@ GET /runners?status=active | Attribute | Type | Required | Description | |-----------|---------|----------|---------------------| -| `scope` | string | no | The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided | +| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided | | `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | | `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` | @@ -66,7 +66,7 @@ GET /runners/all?status=active | Attribute | Type | Required | Description | |-----------|---------|----------|---------------------| -| `scope` | string | no | The scope of runners to show, one of: `specific`, `shared`, `active`, `paused`, `online`, `offline`; showing all runners if none provided | +| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of runners to show, one of: `specific`, `shared`, `active`, `paused`, `online`, `offline`; showing all runners if none provided | | `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | | `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` | @@ -352,7 +352,7 @@ GET /projects/:id/runners?status=active | 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 | no | The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided | +| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided | | `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | | `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` | |