debian-mirror-gitlab/lib/api/admin/ci/variables.rb

140 lines
4.3 KiB
Ruby
Raw Normal View History

2020-05-24 23:13:21 +05:30
# frozen_string_literal: true
module API
module Admin
module Ci
2021-01-03 14:25:43 +05:30
class Variables < ::API::Base
2020-05-24 23:13:21 +05:30
include PaginationParams
before { authenticated_as_admin! }
2021-01-29 00:20:46 +05:30
feature_category :continuous_integration
2020-05-24 23:13:21 +05:30
namespace 'admin' do
namespace 'ci' do
namespace 'variables' do
desc 'Get instance-level variables' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2020-05-24 23:13:21 +05:30
end
params do
use :pagination
end
get '/' do
variables = ::Ci::InstanceVariable.all
2020-10-24 23:57:45 +05:30
present paginate(variables), with: Entities::Ci::Variable
2020-05-24 23:13:21 +05:30
end
desc 'Get a specific variable from a group' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2020-05-24 23:13:21 +05:30
end
params do
requires :key, type: String, desc: 'The key of the variable'
end
get ':key' do
key = params[:key]
variable = ::Ci::InstanceVariable.find_by_key(key)
break not_found!('InstanceVariable') unless variable
2020-10-24 23:57:45 +05:30
present variable, with: Entities::Ci::Variable
2020-05-24 23:13:21 +05:30
end
desc 'Create a new instance-level variable' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2020-05-24 23:13:21 +05:30
end
params do
requires :key,
type: String,
desc: 'The key of the variable'
requires :value,
type: String,
desc: 'The value of the variable'
optional :protected,
type: String,
desc: 'Whether the variable is protected'
optional :masked,
type: String,
desc: 'Whether the variable is masked'
optional :variable_type,
type: String,
values: ::Ci::InstanceVariable.variable_types.keys,
desc: 'The type of variable, must be one of env_var or file. Defaults to env_var'
end
post '/' do
variable_params = declared_params(include_missing: false)
variable = ::Ci::InstanceVariable.new(variable_params)
if variable.save
2020-10-24 23:57:45 +05:30
present variable, with: Entities::Ci::Variable
2020-05-24 23:13:21 +05:30
else
render_validation_error!(variable)
end
end
desc 'Update an existing instance-variable' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2020-05-24 23:13:21 +05:30
end
params do
optional :key,
type: String,
desc: 'The key of the variable'
optional :value,
type: String,
desc: 'The value of the variable'
optional :protected,
type: String,
desc: 'Whether the variable is protected'
optional :masked,
type: String,
desc: 'Whether the variable is masked'
optional :variable_type,
type: String,
values: ::Ci::InstanceVariable.variable_types.keys,
desc: 'The type of variable, must be one of env_var or file'
end
put ':key' do
variable = ::Ci::InstanceVariable.find_by_key(params[:key])
break not_found!('InstanceVariable') unless variable
variable_params = declared_params(include_missing: false).except(:key)
if variable.update(variable_params)
2020-10-24 23:57:45 +05:30
present variable, with: Entities::Ci::Variable
2020-05-24 23:13:21 +05:30
else
render_validation_error!(variable)
end
end
desc 'Delete an existing instance-level variable' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2020-05-24 23:13:21 +05:30
end
params do
requires :key, type: String, desc: 'The key of the variable'
end
delete ':key' do
variable = ::Ci::InstanceVariable.find_by_key(params[:key])
not_found!('InstanceVariable') unless variable
variable.destroy
no_content!
end
end
end
end
end
end
end
end