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

add Ci::Runner.offline scope to API

Browse source
This commit is contained in:
Alexis Reigel 2018-06-06 15:55:14 +02:00
parent 00647b31b4
commit f0d0400d0b
No known key found for this signature in database
GPG key ID: 55ADA7C7B683B329
2 changed files with 9 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/api/runners.md
View file

@ -15,7 +15,7 @@ GET /runners?scope=active
| Attribute | Type | Required | Description |
|-----------|---------|----------|---------------------|
| `scope` | string | no | The scope of specific runners to show, one of: `active`, `paused`, `online`; showing all runners if none provided |
| `scope` | string | no | The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided |
```
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/runners"
@ -60,7 +60,7 @@ GET /runners/all?scope=online
| Attribute | Type | Required | Description |
|-----------|---------|----------|---------------------|
| `scope` | string | no | The scope of runners to show, one of: `specific`, `shared`, `active`, `paused`, `online`; showing all runners if none provided |
| `scope` | string | no | The scope of runners to show, one of: `specific`, `shared`, `active`, `paused`, `online`, `offline`; showing all runners if none provided |
```
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/runners/all"

17
lib/api/runners.rb
View file

@ -9,12 +9,12 @@ module API
success Entities::Runner
end
params do
optional :scope, type: String, values: %w[active paused online],
optional :scope, type: String, values: %w[active paused online offline],
desc: 'The scope of specific runners to show'
use :pagination
end
get do
runners = filter_runners(current_user.ci_owned_runners, params[:scope], without: %w(specific shared))
runners = filter_runners(current_user.ci_owned_runners, params[:scope], only: Ci::Runner::AVAILABLE_STATUSES)
present paginate(runners), with: Entities::Runner
end
@ -22,7 +22,7 @@ module API
success Entities::Runner
end
params do
optional :scope, type: String, values: %w[active paused online specific shared],
optional :scope, type: String, values: %w[active paused online offline specific shared],
desc: 'The scope of specific runners to show'
use :pagination
end
@ -114,7 +114,7 @@ module API
success Entities::Runner
end
params do
optional :scope, type: String, values: %w[active paused online specific shared],
optional :scope, type: String, values: %w[active paused online offline specific shared],
desc: 'The scope of specific runners to show'
use :pagination
end
@ -158,15 +158,12 @@ module API
end
helpers do
def filter_runners(runners, scope, options = {})
def filter_runners(runners, scope, only: nil)
return runners unless scope.present?
available_scopes = ::Ci::Runner::AVAILABLE_SCOPES
if options[:without]
available_scopes = available_scopes - options[:without]
end
available_scopes = only || ::Ci::Runner::AVAILABLE_SCOPES
if (available_scopes & [scope]).empty?
unless available_scopes.include?(scope)
render_api_error!('Scope contains invalid value', 400)
end