module Gitlab # MergeRequest API class MergeRequests < Grape::API before { authenticate! } resource :projects do helpers do # If an error occurred this helper method provides an appropriate status code # # Parameters: # merge_request_errors (required) - The errors collection of MR # def handle_merge_request_error(merge_request_errors) if merge_request_errors[:target_branch].any? error!(merge_request_errors[:target_branch], 400) elsif merge_request_errors[:source_branch].any? error!(merge_request_errors[:source_branch], 400) elsif merge_request_errors[:base].any? error!(merge_request_errors[:base], 422) end end end # List merge requests # # Parameters: # id (required) - The ID of a project # # Example: # GET /projects/:id/merge_requests # get ":id/merge_requests" do authorize! :read_merge_request, user_project present paginate(user_project.merge_requests), with: Entities::MergeRequest end # Show MR # # Parameters: # id (required) - The ID of a project # merge_request_id (required) - The ID of MR # # Example: # GET /projects/:id/merge_request/:merge_request_id # get ":id/merge_request/:merge_request_id" do merge_request = user_project.merge_requests.find(params[:merge_request_id]) authorize! :read_merge_request, merge_request present merge_request, with: Entities::MergeRequest end # Create MR # # Parameters: # # id (required) - The ID of a project # source_branch (required) - The source branch # target_branch (required) - The target branch # assignee_id - Assignee user ID # title (required) - Title of MR # # Example: # POST /projects/:id/merge_requests # post ":id/merge_requests" do authorize! :write_merge_request, user_project attrs = attributes_for_keys [:source_branch, :target_branch, :assignee_id, :title] merge_request = user_project.merge_requests.new(attrs) merge_request.author = current_user if merge_request.save merge_request.reload_code present merge_request, with: Entities::MergeRequest else handle_merge_request_error(merge_request.errors) not_found! end end # Update MR # # Parameters: # id (required) - The ID of a project # merge_request_id (required) - ID of MR # source_branch - The source branch # target_branch - The target branch # assignee_id - Assignee user ID # title - Title of MR # closed - Status of MR. true - closed # Example: # PUT /projects/:id/merge_request/:merge_request_id # put ":id/merge_request/:merge_request_id" do attrs = attributes_for_keys [:source_branch, :target_branch, :assignee_id, :title, :closed] merge_request = user_project.merge_requests.find(params[:merge_request_id]) authorize! :modify_merge_request, merge_request if merge_request.update_attributes attrs merge_request.reload_code merge_request.mark_as_unchecked present merge_request, with: Entities::MergeRequest else handle_merge_request_error(merge_request.errors) not_found! end end # Post comment to merge request # # Parameters: # id (required) - The ID of a project # merge_request_id (required) - ID of MR # note (required) - Text of comment # Examples: # POST /projects/:id/merge_request/:merge_request_id/comments # post ":id/merge_request/:merge_request_id/comments" do merge_request = user_project.merge_requests.find(params[:merge_request_id]) note = merge_request.notes.new(note: params[:note], project_id: user_project.id) note.author = current_user if note.save present note, with: Entities::MRNote else not_found! end end end end end