triggers.rb 3.4 KB
Newer Older
R
Robert Schilling 已提交
1 2 3 4 5 6 7 8
module API
  module V3
    class Triggers < Grape::API
      include PaginationParams

      params do
        requires :id, type: String, desc: 'The ID of a project'
      end
9
      resource :projects, requirements: { id: %r{[^/]+} } do
K
Kamil Trzcinski 已提交
10 11 12 13 14 15 16 17
        desc 'Trigger a GitLab project build' do
          success ::API::V3::Entities::TriggerRequest
        end
        params do
          requires :ref, type: String, desc: 'The commit sha or name of a branch or tag'
          requires :token, type: String, desc: 'The unique token of trigger'
          optional :variables, type: Hash, desc: 'The list of variables to be injected into build'
        end
18
        post ":id/(ref/:ref/)trigger/builds", requirements: { ref: /.+/ } do
K
Kamil Trzcinski 已提交
19 20 21 22 23 24 25 26 27 28 29 30 31
          project = find_project(params[:id])
          trigger = Ci::Trigger.find_by_token(params[:token].to_s)
          not_found! unless project && trigger
          unauthorized! unless trigger.project == project

          # validate variables
          variables = params[:variables].to_h
          unless variables.all? { |key, value| key.is_a?(String) && value.is_a?(String) }
            render_api_error!('variables needs to be a map of key-valued strings', 400)
          end

          # create request and trigger builds
          trigger_request = Ci::CreateTriggerRequestService.new.execute(project, trigger, params[:ref].to_s, variables)
32 33 34
          pipeline = trigger_request.pipeline

          if pipeline.persisted?
K
Kamil Trzcinski 已提交
35 36
            present trigger_request, with: ::API::V3::Entities::TriggerRequest
          else
37
            render_validation_error!(pipeline)
K
Kamil Trzcinski 已提交
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
          end
        end

        desc 'Get triggers list' do
          success ::API::V3::Entities::Trigger
        end
        params do
          use :pagination
        end
        get ':id/triggers' do
          authenticate!
          authorize! :admin_build, user_project

          triggers = user_project.triggers.includes(:trigger_requests)

          present paginate(triggers), with: ::API::V3::Entities::Trigger
        end

        desc 'Get specific trigger of a project' do
          success ::API::V3::Entities::Trigger
        end
        params do
          requires :token, type: String, desc: 'The unique token of trigger'
        end
        get ':id/triggers/:token' do
          authenticate!
          authorize! :admin_build, user_project

          trigger = user_project.triggers.find_by(token: params[:token].to_s)
          return not_found!('Trigger') unless trigger

          present trigger, with: ::API::V3::Entities::Trigger
        end

        desc 'Create a trigger' do
          success ::API::V3::Entities::Trigger
        end
        post ':id/triggers' do
          authenticate!
          authorize! :admin_build, user_project

          trigger = user_project.triggers.create

          present trigger, with: ::API::V3::Entities::Trigger
        end

R
Robert Schilling 已提交
84
        desc 'Delete a trigger' do
K
Kamil Trzcinski 已提交
85
          success ::API::V3::Entities::Trigger
R
Robert Schilling 已提交
86 87 88 89 90 91 92 93 94 95 96 97 98
        end
        params do
          requires :token, type: String, desc: 'The unique token of trigger'
        end
        delete ':id/triggers/:token' do
          authenticate!
          authorize! :admin_build, user_project

          trigger = user_project.triggers.find_by(token: params[:token].to_s)
          return not_found!('Trigger') unless trigger

          trigger.destroy

K
Kamil Trzcinski 已提交
99
          present trigger, with: ::API::V3::Entities::Trigger
R
Robert Schilling 已提交
100 101 102 103 104
        end
      end
    end
  end
end