BigW Consortium Gitlab
Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
G
gitlab-ce
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Forest Godfrey
gitlab-ce
Commits
cd62c747
Commit
cd62c747
authored
Feb 02, 2016
by
Achilleas Pipinellis
Committed by
Tomasz Maczukin
Feb 19, 2016
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add `Example response` above each json output
[ci skip]
parent
1532d28c
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
21 additions
and
7 deletions
+21
-7
runners.md
doc/api/runners.md
+21
-7
No files found.
doc/api/runners.md
View file @
cd62c747
...
...
@@ -8,7 +8,7 @@ Get a list of runners.
GET /runners
```
| Attribute | Type |
r
equired | Description |
| Attribute | Type |
R
equired | Description |
|-----------|---------|----------|---------------------|
|
`scope`
| string | no | The scope of runners to show, one of:
`specific`
,
`shared`
,
`active`
,
`paused`
,
`online`
; showing all runners if none provided |
...
...
@@ -16,6 +16,8 @@ GET /runners
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners"
```
Example response:
```
json
[
{
...
...
@@ -43,7 +45,7 @@ Get details of a runner.
GET /runners/:id
```
| Attribute | Type |
r
equired | Description |
| Attribute | Type |
R
equired | Description |
|-----------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a runner |
...
...
@@ -51,6 +53,8 @@ GET /runners/:id
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/6"
```
Example response:
```
json
{
"active"
:
true
,
...
...
@@ -78,7 +82,7 @@ Update details of a runner.
PUT /runners/:id
```
| Attribute | Type |
r
equired | Description |
| Attribute | Type |
R
equired | Description |
|---------------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a runner |
|
`description`
| string | no | The description of a runner |
...
...
@@ -89,6 +93,8 @@ PUT /runners/:id
curl -X PUT -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/6" -F "description=test-1-20150125-test" -F "tag_list=ruby,mysql,tag1,tag2"
```
Example response:
```
json
{
"active"
:
true
,
...
...
@@ -118,7 +124,7 @@ Remove a runner.
DELETE /runners/:id
```
| Attribute | Type |
r
equired | Description |
| Attribute | Type |
R
equired | Description |
|-----------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a runner |
...
...
@@ -126,6 +132,8 @@ DELETE /runners/:id
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/runners/6"
```
Example response:
```
json
{
"active"
:
true
,
...
...
@@ -151,7 +159,7 @@ is defined **and** shared runners usage is enabled in project's settings.
GET /projects/:id/runners
```
| Attribute | Type |
r
equired | Description |
| Attribute | Type |
R
equired | Description |
|-----------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a project |
...
...
@@ -159,6 +167,8 @@ GET /projects/:id/runners
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners"
```
Example response:
```
json
[
{
...
...
@@ -186,7 +196,7 @@ Enable available specific runner in project.
PUT /projects/:id/runners/:runner_id
```
| Attribute | Type |
r
equired | Description |
| Attribute | Type |
R
equired | Description |
|-------------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a project |
|
`runner_id`
| integer | yes | The ID of a runner |
...
...
@@ -195,6 +205,8 @@ PUT /projects/:id/runners/:runner_id
curl -X PUT -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners/9"
```
Example response:
```
json
{
"active"
:
true
,
...
...
@@ -214,7 +226,7 @@ specified runner. If so, then an error is returned and user should use the [remo
PUT /projects/:id/runners/:runner_id
```
| Attribute | Type |
r
equired | Description |
| Attribute | Type |
R
equired | Description |
|-------------|---------|----------|---------------------|
|
`id`
| integer | yes | The ID of a project |
|
`runner_id`
| integer | yes | The ID of a runner |
...
...
@@ -223,6 +235,8 @@ PUT /projects/:id/runners/:runner_id
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners/9"
```
Example response:
```
json
{
"active"
:
true
,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment