113 lines
4 KiB
Ruby
113 lines
4 KiB
Ruby
module API
|
|
class Pipelines < Grape::API
|
|
include PaginationParams
|
|
|
|
before { authenticate! }
|
|
|
|
params do
|
|
requires :id, type: String, desc: 'The project ID'
|
|
end
|
|
resource :projects, requirements: API::PROJECT_ENDPOINT_REQUIREMENTS do
|
|
desc 'Get all Pipelines of the project' do
|
|
detail 'This feature was introduced in GitLab 8.11.'
|
|
success Entities::PipelineBasic
|
|
end
|
|
params do
|
|
use :pagination
|
|
optional :scope, type: String, values: %w[running pending finished branches tags],
|
|
desc: 'The scope of pipelines'
|
|
optional :status, type: String, values: HasStatus::AVAILABLE_STATUSES,
|
|
desc: 'The status of pipelines'
|
|
optional :ref, type: String, desc: 'The ref of pipelines'
|
|
optional :sha, type: String, desc: 'The sha of pipelines'
|
|
optional :yaml_errors, type: Boolean, desc: 'Returns pipelines with invalid configurations'
|
|
optional :name, type: String, desc: 'The name of the user who triggered pipelines'
|
|
optional :username, type: String, desc: 'The username of the user who triggered pipelines'
|
|
optional :order_by, type: String, values: PipelinesFinder::ALLOWED_INDEXED_COLUMNS, default: 'id',
|
|
desc: 'Order pipelines'
|
|
optional :sort, type: String, values: %w[asc desc], default: 'desc',
|
|
desc: 'Sort pipelines'
|
|
end
|
|
get ':id/pipelines' do
|
|
authorize! :read_pipeline, user_project
|
|
|
|
pipelines = PipelinesFinder.new(user_project, params).execute
|
|
present paginate(pipelines), with: Entities::PipelineBasic
|
|
end
|
|
|
|
desc 'Create a new pipeline' do
|
|
detail 'This feature was introduced in GitLab 8.14'
|
|
success Entities::Pipeline
|
|
end
|
|
params do
|
|
requires :ref, type: String, desc: 'Reference'
|
|
end
|
|
post ':id/pipeline' do
|
|
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42124')
|
|
|
|
authorize! :create_pipeline, user_project
|
|
|
|
new_pipeline = Ci::CreatePipelineService.new(user_project,
|
|
current_user,
|
|
declared_params(include_missing: false))
|
|
.execute(:api, ignore_skip_ci: true, save_on_errors: false)
|
|
|
|
if new_pipeline.persisted?
|
|
present new_pipeline, with: Entities::Pipeline
|
|
else
|
|
render_validation_error!(new_pipeline)
|
|
end
|
|
end
|
|
|
|
desc 'Gets a specific pipeline for the project' do
|
|
detail 'This feature was introduced in GitLab 8.11'
|
|
success Entities::Pipeline
|
|
end
|
|
params do
|
|
requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
|
|
end
|
|
get ':id/pipelines/:pipeline_id' do
|
|
authorize! :read_pipeline, user_project
|
|
|
|
present pipeline, with: Entities::Pipeline
|
|
end
|
|
|
|
desc 'Retry builds in the pipeline' do
|
|
detail 'This feature was introduced in GitLab 8.11.'
|
|
success Entities::Pipeline
|
|
end
|
|
params do
|
|
requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
|
|
end
|
|
post ':id/pipelines/:pipeline_id/retry' do
|
|
authorize! :update_pipeline, user_project
|
|
|
|
pipeline.retry_failed(current_user)
|
|
|
|
present pipeline, with: Entities::Pipeline
|
|
end
|
|
|
|
desc 'Cancel all builds in the pipeline' do
|
|
detail 'This feature was introduced in GitLab 8.11.'
|
|
success Entities::Pipeline
|
|
end
|
|
params do
|
|
requires :pipeline_id, type: Integer, desc: 'The pipeline ID'
|
|
end
|
|
post ':id/pipelines/:pipeline_id/cancel' do
|
|
authorize! :update_pipeline, user_project
|
|
|
|
pipeline.cancel_running
|
|
|
|
status 200
|
|
present pipeline.reload, with: Entities::Pipeline
|
|
end
|
|
end
|
|
|
|
helpers do
|
|
def pipeline
|
|
@pipeline ||= user_project.pipelines.find(params[:pipeline_id])
|
|
end
|
|
end
|
|
end
|
|
end
|