diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-02-03 15:39:55 +0200 |
|---|---|---|
| committer | Tomasz Maczukin <tomasz@maczukin.pl> | 2016-02-19 13:18:47 +0100 |
| commit | dc32af950821946f5bc3a4e57b4b7eeb0ffb032f (patch) | |
| tree | 3869c8c59e5fd1346193b8d10841f270a0f2999e /doc/api | |
| parent | a09ae17337147e5a51f3cc6a342ca02747d48c33 (diff) | |
| download | gitlab-ce-dc32af950821946f5bc3a4e57b4b7eeb0ffb032f.tar.gz | |
More fixes in runners doc
[ci skip]
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/runners.md | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/api/runners.md b/doc/api/runners.md index 213b9a99678..8e7351d01ec 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -2,10 +2,11 @@ ## List owned runners -Get a list of specific runners available for user. +Get a list of runners available to the user. ``` GET /runners +GET /runners?scope=active ``` | Attribute | Type | Required | Description | @@ -39,10 +40,12 @@ Example response: ## List all runners -Get a list of all runners (specific and shared). Access restricted to users with `admin` privileges. +Get a list of all runners in the GitLab instance (specific and shared). Access +is restricted to users with `admin` privileges. ``` GET /runners/all +GET /runners?scope=online ``` | Attribute | Type | Required | Description | @@ -210,8 +213,9 @@ Example response: ## List project's runners -List all runners (*shared* and *specific*) available in project. Shared runners are listed if at least one shared runner -is defined **and** shared runners usage is enabled in project's settings. +List all runners (specific and shared) available in the project. Shared runners +are listed if at least one shared runner is defined **and** shared runners +usage is enabled in the project's settings. ``` GET /projects/:id/runners @@ -222,7 +226,7 @@ GET /projects/:id/runners | `id` | integer | yes | The ID of a project | ``` -curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners" +curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/9/runners" ``` Example response: @@ -248,7 +252,7 @@ Example response: ## Enable a runner in project -Enable available specific runner in project. +Enable an available specific runner in the project. ``` POST /projects/:id/runners/:runner_id @@ -277,8 +281,9 @@ Example response: ## Disable a runner from project -Disable a specific runner from project. It works only, if the project isn't an only project associated with the -specified runner. If so, then an error is returned and user should use the [remove a runner](#remove-a-runner) feature. +Disable a specific runner from the project. It works only if the project isn't +the only project associated with the specified runner. If so, an error is +returned. Use the [Remove a runner](#remove-a-runner) call instead. ``` DELETE /projects/:id/runners/:runner_id |