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

91 lines
2.7 KiB
Ruby
Raw Normal View History

module API
# Projects variables API
class Variables < Grape::API
before { authenticate! }
before { authorize! :admin_build, user_project }
2016-10-12 14:38:33 -04:00
params do
requires :id, type: String, desc: 'The ID of a project'
end
resource :projects do
2016-10-12 14:38:33 -04:00
desc 'Get project variables' do
success Entities::Variable
end
params do
optional :page, type: Integer, desc: 'The page number for pagination'
optional :per_page, type: Integer, desc: 'The value of items per page to show'
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
get ':id/variables/:key' do
key = params[:key]
2016-01-13 06:47:11 -05:00
variable = user_project.variables.find_by(key: key.to_s)
2016-01-13 06:47:11 -05:00
return not_found!('Variable') unless variable
2016-01-13 06:47:11 -05:00
present variable, with: Entities::Variable
end
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'
end
2015-12-31 16:30:07 -05:00
post ':id/variables' do
2016-10-12 14:38:33 -04:00
variable = user_project.variables.create(declared(params, include_parent_namespaces: false).to_h)
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'
end
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
return not_found!('Variable') unless variable
2016-10-12 14:38:33 -04:00
if variable.update(value: params[:value])
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
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
delete ':id/variables/:key' do
2016-10-12 14:38:33 -04:00
variable = user_project.variables.find_by(key: params[:key])
return not_found!('Variable') unless variable
2015-12-31 16:30:07 -05:00
2016-10-12 14:38:33 -04:00
present variable.destroy, with: Entities::Variable
2015-12-31 10:56:03 -05:00
end
end
end
end