debian-mirror-gitlab/lib/api/group_variables.rb

128 lines
4.2 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2017-09-10 17:25:29 +05:30
module API
2021-01-03 14:25:43 +05:30
class GroupVariables < ::API::Base
2017-09-10 17:25:29 +05:30
include PaginationParams
before { authenticate! }
2021-03-05 16:19:46 +05:30
before { authorize! :admin_group, user_group }
2021-11-11 11:23:49 +05:30
feature_category :pipeline_authoring
2021-01-29 00:20:46 +05:30
2021-10-27 15:23:28 +05:30
helpers ::API::Helpers::VariablesHelpers
2021-04-29 21:17:54 +05:30
2017-09-10 17:25:29 +05:30
params do
requires :id, type: String, desc: 'The ID of a group'
end
2019-02-15 15:39:39 +05:30
resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-09-10 17:25:29 +05:30
desc 'Get group-level variables' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2017-09-10 17:25:29 +05:30
end
params do
use :pagination
end
get ':id/variables' do
variables = user_group.variables
2020-10-24 23:57:45 +05:30
present paginate(variables), with: Entities::Ci::Variable
2017-09-10 17:25:29 +05:30
end
desc 'Get a specific variable from a group' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2017-09-10 17:25:29 +05:30
end
params do
requires :key, type: String, desc: 'The key of the variable'
end
get ':id/variables/:key' do
2021-04-29 21:17:54 +05:30
variable = find_variable(user_group, params)
2017-09-10 17:25:29 +05:30
2018-10-15 14:42:47 +05:30
break not_found!('GroupVariable') unless variable
2017-09-10 17:25:29 +05:30
2020-10-24 23:57:45 +05:30
present variable, with: Entities::Ci::Variable
2017-09-10 17:25:29 +05:30
end
desc 'Create a new variable in a group' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2017-09-10 17:25:29 +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'
2020-04-08 14:13:33 +05:30
optional :masked, type: String, desc: 'Whether the variable is masked'
2020-07-28 23:09:34 +05:30
optional :variable_type, type: String, values: ::Ci::GroupVariable.variable_types.keys, desc: 'The type of variable, must be one of env_var or file. Defaults to env_var'
2021-04-29 21:17:54 +05:30
use :optional_group_variable_params_ee
2017-09-10 17:25:29 +05:30
end
post ':id/variables' do
2021-04-29 21:17:54 +05:30
filtered_params = filter_variable_parameters(
user_group,
declared_params(include_missing: false)
)
2020-10-24 23:57:45 +05:30
variable = ::Ci::ChangeVariableService.new(
container: user_group,
current_user: current_user,
2021-04-29 21:17:54 +05:30
params: { action: :create, variable_params: filtered_params }
2020-10-24 23:57:45 +05:30
).execute
2017-09-10 17:25:29 +05:30
if variable.valid?
2020-10-24 23:57:45 +05:30
present variable, with: Entities::Ci::Variable
2017-09-10 17:25:29 +05:30
else
render_validation_error!(variable)
end
end
desc 'Update an existing variable from a group' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2017-09-10 17:25:29 +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'
2020-04-08 14:13:33 +05:30
optional :masked, type: String, desc: 'Whether the variable is masked'
2020-07-28 23:09:34 +05:30
optional :variable_type, type: String, values: ::Ci::GroupVariable.variable_types.keys, desc: 'The type of variable, must be one of env_var or file'
2021-04-29 21:17:54 +05:30
use :optional_group_variable_params_ee
2017-09-10 17:25:29 +05:30
end
put ':id/variables/:key' do
2021-04-29 21:17:54 +05:30
filtered_params = filter_variable_parameters(
user_group,
declared_params(include_missing: false)
)
2020-10-24 23:57:45 +05:30
variable = ::Ci::ChangeVariableService.new(
container: user_group,
current_user: current_user,
2021-04-29 21:17:54 +05:30
params: { action: :update, variable_params: filtered_params }
2020-10-24 23:57:45 +05:30
).execute
2017-09-10 17:25:29 +05:30
2020-10-24 23:57:45 +05:30
if variable.valid?
present variable, with: Entities::Ci::Variable
2017-09-10 17:25:29 +05:30
else
render_validation_error!(variable)
end
2020-10-24 23:57:45 +05:30
rescue ::ActiveRecord::RecordNotFound
not_found!('GroupVariable')
2017-09-10 17:25:29 +05:30
end
desc 'Delete an existing variable from a group' do
2020-10-24 23:57:45 +05:30
success Entities::Ci::Variable
2017-09-10 17:25:29 +05:30
end
params do
requires :key, type: String, desc: 'The key of the variable'
end
delete ':id/variables/:key' do
2021-04-29 21:17:54 +05:30
variable = find_variable(user_group, params)
break not_found!('GroupVariable') unless variable
2020-10-24 23:57:45 +05:30
destroy_conditionally!(variable) do |target_variable|
::Ci::ChangeVariableService.new(
container: user_group,
current_user: current_user,
2021-04-29 21:17:54 +05:30
params: { action: :destroy, variable: variable }
2020-10-24 23:57:45 +05:30
).execute
end
2017-09-10 17:25:29 +05:30
end
end
end
end