gitlab-org--gitlab-foss/lib/api/group_variables.rb

104 lines
3.1 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
2017-07-18 08:40:35 -04:00
module API
class GroupVariables < Grape::API
include PaginationParams
before { authenticate! }
before { authorize! :admin_build, user_group }
params do
requires :id, type: String, desc: 'The ID of a group'
end
resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-07-18 08:40:35 -04:00
desc 'Get group-level variables' do
success Entities::Variable
end
params do
use :pagination
end
get ':id/variables' do
variables = user_group.variables
present paginate(variables), with: Entities::Variable
end
desc 'Get a specific variable from a group' do
success Entities::Variable
end
params do
requires :key, type: String, desc: 'The key of the variable'
end
# rubocop: disable CodeReuse/ActiveRecord
2017-07-18 08:40:35 -04:00
get ':id/variables/:key' do
key = params[:key]
variable = user_group.variables.find_by(key: key)
break not_found!('GroupVariable') unless variable
2017-07-18 08:40:35 -04:00
present variable, with: Entities::Variable
end
# rubocop: enable CodeReuse/ActiveRecord
2017-07-18 08:40:35 -04:00
desc 'Create a new variable in a group' do
success Entities::Variable
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'
end
post ':id/variables' do
variable_params = declared_params(include_missing: false)
variable = user_group.variables.create(variable_params)
if variable.valid?
present variable, with: Entities::Variable
else
render_validation_error!(variable)
end
end
desc 'Update an existing variable from a group' do
success Entities::Variable
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'
end
# rubocop: disable CodeReuse/ActiveRecord
2017-07-18 08:40:35 -04:00
put ':id/variables/:key' do
variable = user_group.variables.find_by(key: params[:key])
break not_found!('GroupVariable') unless variable
2017-07-18 08:40:35 -04:00
variable_params = declared_params(include_missing: false).except(:key)
if variable.update(variable_params)
present variable, with: Entities::Variable
else
render_validation_error!(variable)
end
end
# rubocop: enable CodeReuse/ActiveRecord
2017-07-18 08:40:35 -04:00
desc 'Delete an existing variable from a group' do
success Entities::Variable
end
params do
requires :key, type: String, desc: 'The key of the variable'
end
# rubocop: disable CodeReuse/ActiveRecord
2017-07-18 08:40:35 -04:00
delete ':id/variables/:key' do
variable = user_group.variables.find_by(key: params[:key])
not_found!('GroupVariable') unless variable
2017-08-24 04:41:54 -04:00
destroy_conditionally!(variable)
2017-07-18 08:40:35 -04:00
end
# rubocop: enable CodeReuse/ActiveRecord
2017-07-18 08:40:35 -04:00
end
end
end