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

48 lines
1.6 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
2016-08-16 02:45:23 -04:00
module API
# Deployments RESTful API endpoints
2016-08-16 02:45:23 -04:00
class Deployments < Grape::API
include PaginationParams
2016-08-16 02:45:23 -04:00
before { authenticate! }
params do
requires :id, type: String, desc: 'The project ID'
end
2017-08-31 07:44:49 -04:00
resource :projects, requirements: API::PROJECT_ENDPOINT_REQUIREMENTS do
2016-08-16 02:45:23 -04:00
desc 'Get all deployments of the project' do
detail 'This feature was introduced in GitLab 8.11.'
success Entities::Deployment
end
params do
use :pagination
optional :order_by, type: String, values: %w[id iid created_at ref], default: 'id', desc: 'Return deployments ordered by `id` or `iid` or `created_at` or `ref`'
optional :sort, type: String, values: %w[asc desc], default: 'asc', desc: 'Sort by asc (ascending) or desc (descending)'
2016-08-16 02:45:23 -04:00
end
# rubocop: disable CodeReuse/ActiveRecord
2016-08-16 02:45:23 -04:00
get ':id/deployments' do
authorize! :read_deployment, user_project
present paginate(user_project.deployments.order(params[:order_by] => params[:sort])), with: Entities::Deployment
2016-08-16 02:45:23 -04:00
end
# rubocop: enable CodeReuse/ActiveRecord
2016-08-16 02:45:23 -04:00
desc 'Gets a specific deployment' do
detail 'This feature was introduced in GitLab 8.11.'
success Entities::Deployment
end
params do
requires :deployment_id, type: Integer, desc: 'The deployment ID'
end
get ':id/deployments/:deployment_id' do
authorize! :read_deployment, user_project
deployment = user_project.deployments.find(params[:deployment_id])
present deployment, with: Entities::Deployment
end
end
end
end