kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Add some fixes in runners API documentation

Browse source
This commit is contained in:
Tomasz Maczukin 2016-02-02 14:52:33 +01:00
parent cd62c74700
commit b56ee397bb
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/api/runners.md
View file

@ -164,7 +164,7 @@ GET /projects/:id/runners
| `id` | integer | yes | The ID of a project |
```
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners"
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners"
```
Example response:
@ -193,7 +193,7 @@ Example response:
Enable available specific runner in project.
```
PUT /projects/:id/runners/:runner_id
POST /projects/:id/runners/:runner_id
```
| Attribute | Type | Required | Description |
@ -202,7 +202,7 @@ PUT /projects/:id/runners/:runner_id
| `runner_id` | integer | yes | The ID of a runner |
```
curl -X PUT -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners/9"
curl -X POST -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/project/9/runners/9"
```
Example response:
@ -223,7 +223,7 @@ Disable a specific runner from project. It works only, if the project isn't an o
specified runner. If so, then an error is returned and user should use the [remove a runner](#remove-a-runner) feature.
```
PUT /projects/:id/runners/:runner_id
DELETE /projects/:id/runners/:runner_id
```
| Attribute | Type | Required | Description |

4
lib/api/runners.rb
View file

@ -87,8 +87,8 @@ module API
# id (required) - The ID of the project
# runner_id (required) - The ID of the runner
# Example Request:
# PUT /projects/:id/runners/:runner_id
put ':id/runners/:runner_id' do
# POST /projects/:id/runners/:runner_id
post ':id/runners/:runner_id' do
runner = get_runner(params[:runner_id])
can_enable_runner?(runner)
Ci::RunnerProject.create(runner: runner, project: user_project)