2018-09-29 18:34:47 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2015-12-31 09:19:13 -05:00
|
|
|
module API
|
|
|
|
class Variables < Grape::API
|
2016-11-21 14:15:46 -05:00
|
|
|
include PaginationParams
|
|
|
|
|
2015-12-31 09:19:13 -05:00
|
|
|
before { authenticate! }
|
2016-02-01 17:58:04 -05:00
|
|
|
before { authorize! :admin_build, user_project }
|
2015-12-31 09:19:13 -05:00
|
|
|
|
2019-03-04 08:50:15 -05:00
|
|
|
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
|
|
|
|
|
2019-01-16 07:09:29 -05:00
|
|
|
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
|
2016-11-21 14:15:46 -05:00
|
|
|
use :pagination
|
2016-10-12 14:38:33 -04:00
|
|
|
end
|
2015-12-31 09:19:13 -05:00
|
|
|
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
|
2018-08-27 11:31:01 -04:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2016-01-07 07:49:38 -05:00
|
|
|
get ':id/variables/:key' do
|
|
|
|
key = params[:key]
|
2016-11-24 07:30:53 -05:00
|
|
|
variable = user_project.variables.find_by(key: key)
|
2015-12-31 09:19:13 -05:00
|
|
|
|
2018-04-18 05:19:40 -04:00
|
|
|
break not_found!('Variable') unless variable
|
2015-12-31 11:03:11 -05:00
|
|
|
|
2016-01-13 06:47:11 -05:00
|
|
|
present variable, with: Entities::Variable
|
2015-12-31 09:19:13 -05:00
|
|
|
end
|
2018-08-27 11:31:01 -04:00
|
|
|
# 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'
|
2017-05-25 07:49:46 -04:00
|
|
|
optional :protected, type: String, desc: 'Whether the variable is protected'
|
2019-03-25 10:47:55 -04:00
|
|
|
|
|
|
|
if Gitlab.ee?
|
|
|
|
optional :environment_scope, type: String, desc: 'The environment_scope of the variable'
|
|
|
|
end
|
2016-10-12 14:38:33 -04:00
|
|
|
end
|
2015-12-31 16:30:07 -05:00
|
|
|
post ':id/variables' do
|
2017-07-06 03:45:38 -04:00
|
|
|
variable_params = declared_params(include_missing: false)
|
2019-03-04 08:50:15 -05:00
|
|
|
variable_params = filter_variable_parameters(variable_params)
|
2017-07-06 03:45:38 -04:00
|
|
|
|
|
|
|
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'
|
2017-05-25 07:49:46 -04:00
|
|
|
optional :protected, type: String, desc: 'Whether the variable is protected'
|
2019-03-25 10:47:55 -04:00
|
|
|
|
|
|
|
if Gitlab.ee?
|
|
|
|
optional :environment_scope, type: String, desc: 'The environment_scope of the variable'
|
|
|
|
end
|
2016-10-12 14:38:33 -04:00
|
|
|
end
|
2018-08-27 11:31:01 -04:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2016-01-07 07:49:38 -05:00
|
|
|
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
|
|
|
|
2018-04-18 05:19:40 -04:00
|
|
|
break not_found!('Variable') unless variable
|
2015-12-31 11:03:11 -05:00
|
|
|
|
2017-07-06 03:45:38 -04:00
|
|
|
variable_params = declared_params(include_missing: false).except(:key)
|
2019-03-04 08:50:15 -05:00
|
|
|
variable_params = filter_variable_parameters(variable_params)
|
2017-07-06 03:45:38 -04:00
|
|
|
|
|
|
|
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
|
2018-08-27 11:31:01 -04:00
|
|
|
# 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
|
2018-08-27 11:31:01 -04:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2016-01-07 07:49:38 -05:00
|
|
|
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
|
|
|
|
2017-08-24 04:41:54 -04:00
|
|
|
# Variables don't have any timestamp. Therfore, destroy unconditionally.
|
2017-07-20 09:33:18 -04:00
|
|
|
status 204
|
2017-02-20 13:18:12 -05:00
|
|
|
variable.destroy
|
2015-12-31 10:56:03 -05:00
|
|
|
end
|
2018-08-27 11:31:01 -04:00
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2015-12-31 09:19:13 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|