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

123 lines
4.3 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
module API
class Variables < Grape::API
include PaginationParams
before { authenticate! }
before { authorize! :admin_build, user_project }
helpers do
def filter_variable_parameters(params)
# This method exists so that EE can more easily filter out certain
# parameters, without having to modify the source code directly.
params
end
end
2016-10-12 14:38:33 -04:00
params do
requires :id, type: String, desc: 'The ID of a project'
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2016-10-12 14:38:33 -04:00
desc 'Get project variables' do
success Entities::Variable
end
params do
use :pagination
2016-10-12 14:38:33 -04:00
end
get ':id/variables' do
variables = user_project.variables
present paginate(variables), with: Entities::Variable
end
2016-10-12 14:38:33 -04:00
desc 'Get a specific variable from a project' do
success Entities::Variable
end
params do
requires :key, type: String, desc: 'The key of the variable'
end
# rubocop: disable CodeReuse/ActiveRecord
get ':id/variables/:key' do
key = params[:key]
variable = user_project.variables.find_by(key: key)
break not_found!('Variable') unless variable
2016-01-13 06:47:11 -05:00
present variable, with: Entities::Variable
end
# rubocop: enable CodeReuse/ActiveRecord
2015-12-31 10:25:49 -05:00
2016-10-12 14:38:33 -04:00
desc 'Create a new variable in a project' 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: Boolean, desc: 'Whether the variable is protected'
optional :masked, type: Boolean, desc: 'Whether the variable is masked'
optional :variable_type, type: String, values: Ci::Variable.variable_types.keys, desc: 'The type of variable, must be one of env_var or file. Defaults to env_var'
optional :environment_scope, type: String, desc: 'The environment_scope of the variable'
2016-10-12 14:38:33 -04:00
end
2015-12-31 16:30:07 -05:00
post ':id/variables' do
variable_params = declared_params(include_missing: false)
variable_params = filter_variable_parameters(variable_params)
variable = user_project.variables.create(variable_params)
2015-12-31 16:30:07 -05:00
2016-01-13 06:47:11 -05:00
if variable.valid?
present variable, with: Entities::Variable
else
render_validation_error!(variable)
end
2015-12-31 16:30:07 -05:00
end
2016-10-12 14:38:33 -04:00
desc 'Update an existing variable from a project' 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: Boolean, desc: 'Whether the variable is protected'
optional :masked, type: Boolean, desc: 'Whether the variable is masked'
optional :variable_type, type: String, values: Ci::Variable.variable_types.keys, desc: 'The type of variable, must be one of env_var or file'
optional :environment_scope, type: String, desc: 'The environment_scope of the variable'
2016-10-12 14:38:33 -04:00
end
# rubocop: disable CodeReuse/ActiveRecord
put ':id/variables/:key' do
2016-10-12 14:38:33 -04:00
variable = user_project.variables.find_by(key: params[:key])
2015-12-31 10:25:49 -05:00
break not_found!('Variable') unless variable
variable_params = declared_params(include_missing: false).except(:key)
variable_params = filter_variable_parameters(variable_params)
if variable.update(variable_params)
2016-01-13 06:47:11 -05:00
present variable, with: Entities::Variable
else
render_validation_error!(variable)
end
2015-12-31 10:25:49 -05:00
end
# rubocop: enable CodeReuse/ActiveRecord
2015-12-31 10:56:03 -05:00
2016-10-12 14:38:33 -04:00
desc 'Delete an existing variable from a project' do
success Entities::Variable
end
params do
requires :key, type: String, desc: 'The key of the variable'
end
# rubocop: disable CodeReuse/ActiveRecord
delete ':id/variables/:key' do
2016-10-12 14:38:33 -04:00
variable = user_project.variables.find_by(key: params[:key])
2017-02-20 14:32:44 -05:00
not_found!('Variable') unless variable
2015-12-31 16:30:07 -05:00
# Variables don't have a timestamp. Therefore, destroy unconditionally.
2017-02-20 13:18:12 -05:00
variable.destroy
no_content!
2015-12-31 10:56:03 -05:00
end
# rubocop: enable CodeReuse/ActiveRecord
end
end
end