2018-09-29 22:34:47 +00:00
# frozen_string_literal: true
2017-07-18 12:40:35 +00:00
module API
2020-10-15 00:08:42 +00:00
class GroupVariables < :: API :: Base
2017-07-18 12:40:35 +00:00
include PaginationParams
before { authenticate! }
2021-03-05 00:09:24 +00:00
before { authorize! :admin_group , user_group }
2020-10-29 12:08:50 +00:00
feature_category :continuous_integration
2021-07-20 21:09:52 +00:00
helpers :: API :: Helpers :: VariablesHelpers
2021-03-17 09:09:27 +00:00
2017-07-18 12:40:35 +00:00
params do
requires :id , type : String , desc : 'The ID of a group'
end
2018-11-08 12:18:17 +00:00
resource :groups , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-07-18 12:40:35 +00:00
desc 'Get group-level variables' do
2020-08-13 18:10:36 +00:00
success Entities :: Ci :: Variable
2017-07-18 12:40:35 +00:00
end
params do
use :pagination
end
get ':id/variables' do
variables = user_group . variables
2020-08-13 18:10:36 +00:00
present paginate ( variables ) , with : Entities :: Ci :: Variable
2017-07-18 12:40:35 +00:00
end
desc 'Get a specific variable from a group' do
2020-08-13 18:10:36 +00:00
success Entities :: Ci :: Variable
2017-07-18 12:40:35 +00:00
end
params do
requires :key , type : String , desc : 'The key of the variable'
end
get ':id/variables/:key' do
2021-03-17 09:09:27 +00:00
variable = find_variable ( user_group , params )
2017-07-18 12:40:35 +00:00
2018-04-18 09:19:40 +00:00
break not_found! ( 'GroupVariable' ) unless variable
2017-07-18 12:40:35 +00:00
2020-08-13 18:10:36 +00:00
present variable , with : Entities :: Ci :: Variable
2017-07-18 12:40:35 +00:00
end
desc 'Create a new variable in a group' do
2020-08-13 18:10:36 +00:00
success Entities :: Ci :: Variable
2017-07-18 12:40:35 +00:00
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-02-24 15:09:10 +00:00
optional :masked , type : String , desc : 'Whether the variable is masked'
2020-06-26 00:09:13 +00:00
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-03-17 09:09:27 +00:00
use :optional_group_variable_params_ee
2017-07-18 12:40:35 +00:00
end
post ':id/variables' do
2021-03-17 09:09:27 +00:00
filtered_params = filter_variable_parameters (
user_group ,
declared_params ( include_missing : false )
)
2020-07-30 15:09:40 +00:00
variable = :: Ci :: ChangeVariableService . new (
container : user_group ,
current_user : current_user ,
2021-03-17 09:09:27 +00:00
params : { action : :create , variable_params : filtered_params }
2020-07-30 15:09:40 +00:00
) . execute
2017-07-18 12:40:35 +00:00
if variable . valid?
2020-08-13 18:10:36 +00:00
present variable , with : Entities :: Ci :: Variable
2017-07-18 12:40:35 +00:00
else
render_validation_error! ( variable )
end
end
desc 'Update an existing variable from a group' do
2020-08-13 18:10:36 +00:00
success Entities :: Ci :: Variable
2017-07-18 12:40:35 +00:00
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-02-24 15:09:10 +00:00
optional :masked , type : String , desc : 'Whether the variable is masked'
2020-06-26 00:09:13 +00:00
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-03-17 09:09:27 +00:00
use :optional_group_variable_params_ee
2017-07-18 12:40:35 +00:00
end
put ':id/variables/:key' do
2021-03-17 09:09:27 +00:00
filtered_params = filter_variable_parameters (
user_group ,
declared_params ( include_missing : false )
)
2020-07-30 15:09:40 +00:00
variable = :: Ci :: ChangeVariableService . new (
container : user_group ,
current_user : current_user ,
2021-03-17 09:09:27 +00:00
params : { action : :update , variable_params : filtered_params }
2020-07-30 15:09:40 +00:00
) . execute
2020-07-27 15:09:25 +00:00
2020-07-30 15:09:40 +00:00
if variable . valid?
2020-08-13 18:10:36 +00:00
present variable , with : Entities :: Ci :: Variable
2017-07-18 12:40:35 +00:00
else
render_validation_error! ( variable )
end
2020-07-30 15:09:40 +00:00
rescue :: ActiveRecord :: RecordNotFound
not_found! ( 'GroupVariable' )
2017-07-18 12:40:35 +00:00
end
desc 'Delete an existing variable from a group' do
2020-08-13 18:10:36 +00:00
success Entities :: Ci :: Variable
2017-07-18 12:40:35 +00:00
end
params do
requires :key , type : String , desc : 'The key of the variable'
end
delete ':id/variables/:key' do
2021-03-17 09:09:27 +00:00
variable = find_variable ( user_group , params )
break not_found! ( 'GroupVariable' ) unless variable
2020-07-30 15:09:40 +00:00
destroy_conditionally! ( variable ) do | target_variable |
:: Ci :: ChangeVariableService . new (
container : user_group ,
current_user : current_user ,
2021-03-17 09:09:27 +00:00
params : { action : :destroy , variable : variable }
2020-07-30 15:09:40 +00:00
) . execute
end
2017-07-18 12:40:35 +00:00
end
end
end
end