2018-09-29 18:34:47 -04:00
# frozen_string_literal: true
2013-05-14 08:33:31 -04:00
module API
2020-10-14 20:08:42 -04:00
class MergeRequests < :: API :: Base
2016-12-04 12:11:19 -05:00
include PaginationParams
2020-01-29 10:08:59 -05:00
CONTEXT_COMMITS_POST_LIMIT = 20
2017-09-18 13:29:17 -04:00
before { authenticate_non_get! }
2012-10-21 07:00:27 -04:00
2020-01-13 16:07:39 -05:00
helpers Helpers :: MergeRequestsHelpers
2020-11-26 10:09:30 -05:00
helpers Helpers :: SSEHelpers
2017-07-24 16:07:37 -04:00
2021-04-12 11:09:30 -04:00
# These endpoints are defined in `TimeTrackingEndpoints` and is shared by
# API::Issues. In order to be able to define the feature category of these
# endpoints, we need to define them at the top-level by route.
feature_category :code_review , [
'/projects/:id/merge_requests/:merge_request_iid/time_estimate' ,
'/projects/:id/merge_requests/:merge_request_iid/reset_time_estimate' ,
'/projects/:id/merge_requests/:merge_request_iid/add_spent_time' ,
'/projects/:id/merge_requests/:merge_request_iid/reset_spent_time' ,
'/projects/:id/merge_requests/:merge_request_iid/time_stats'
]
2018-03-05 12:30:05 -05:00
# EE::API::MergeRequests would override the following helpers
helpers do
params :optional_params_ee do
end
2019-03-07 18:55:45 -05:00
params :optional_merge_requests_search_params do
end
2018-03-05 12:30:05 -05:00
end
def self . update_params_at_least_one_of
% i [
assignee_id
2019-04-07 14:35:16 -04:00
assignee_ids
2021-01-21 04:08:52 -05:00
reviewer_ids
2018-03-05 12:30:05 -05:00
description
labels
2020-05-12 05:09:31 -04:00
add_labels
remove_labels
2018-03-05 12:30:05 -05:00
milestone_id
remove_source_branch
2020-09-14 17:09:27 -04:00
allow_collaboration
allow_maintainer_to_push
squash
2018-03-05 12:30:05 -05:00
target_branch
title
2020-09-14 17:09:27 -04:00
state_event
2018-03-05 12:30:05 -05:00
discussion_locked
]
end
2021-05-11 17:10:21 -04:00
prepend_mod_with ( 'API::MergeRequests' ) # rubocop: disable Cop/InjectEnterpriseEditionModule
2019-09-13 09:26:31 -04:00
2017-07-24 16:07:37 -04:00
helpers do
2018-08-27 11:31:01 -04:00
# rubocop: disable CodeReuse/ActiveRecord
2017-07-24 16:07:37 -04:00
def find_merge_requests ( args = { } )
2017-12-19 16:57:46 -05:00
args = declared_params . merge ( args )
2017-07-24 16:07:37 -04:00
args [ :milestone_title ] = args . delete ( :milestone )
2020-07-03 05:08:53 -04:00
args [ :not ] [ :milestone_title ] = args [ :not ] & . delete ( :milestone )
2017-07-24 16:07:37 -04:00
args [ :label_name ] = args . delete ( :labels )
2020-07-03 05:08:53 -04:00
args [ :not ] [ :label_name ] = args [ :not ] & . delete ( :labels )
2018-05-13 22:07:53 -04:00
args [ :scope ] = args [ :scope ] . underscore if args [ :scope ]
2017-07-24 16:07:37 -04:00
merge_requests = MergeRequestsFinder . new ( current_user , args ) . execute
2019-02-16 05:03:42 -05:00
. reorder ( order_options_with_tie_breaker )
2017-07-24 16:07:37 -04:00
merge_requests = paginate ( merge_requests )
2018-06-03 06:31:41 -04:00
. preload ( :source_project , :target_project )
2017-07-24 16:07:37 -04:00
return merge_requests if args [ :view ] == 'simple'
merge_requests
2019-03-02 12:31:36 -05:00
. with_api_entity_associations
2017-07-24 16:07:37 -04:00
end
2018-08-27 11:31:01 -04:00
# rubocop: enable CodeReuse/ActiveRecord
2017-07-24 16:07:37 -04:00
2018-01-10 12:05:34 -05:00
def merge_request_pipelines_with_access
2017-11-16 13:10:15 -05:00
mr = find_merge_request_with_access ( params [ :merge_request_iid ] )
2020-07-15 17:09:26 -04:00
:: Ci :: PipelinesForMergeRequestFinder . new ( mr , current_user ) . execute
2017-11-16 13:10:15 -05:00
end
2020-01-13 13:08:05 -05:00
def automatically_mergeable? ( merge_when_pipeline_succeeds , merge_request )
pipeline_active = merge_request . head_pipeline_active? || merge_request . actual_head_pipeline_active?
merge_when_pipeline_succeeds && merge_request . mergeable_state? ( skip_ci_check : true ) && pipeline_active
end
def immediately_mergeable? ( merge_when_pipeline_succeeds , merge_request )
if merge_when_pipeline_succeeds
merge_request . actual_head_pipeline_success?
else
merge_request . mergeable_state?
end
2019-11-19 04:06:16 -05:00
end
2018-05-31 11:29:07 -04:00
def serializer_options_for ( merge_requests )
2019-12-30 07:09:15 -05:00
options = { with : Entities :: MergeRequestBasic , current_user : current_user , with_labels_details : declared_params [ :with_labels_details ] }
2018-05-31 11:29:07 -04:00
if params [ :view ] == 'simple'
options [ :with ] = Entities :: MergeRequestSimple
else
2020-06-08 17:09:17 -04:00
options [ :skip_merge_status_recheck ] = ! declared_params [ :with_merge_status_recheck ]
2018-05-31 11:29:07 -04:00
end
options
end
2018-11-22 01:02:58 -05:00
def authorize_push_to_merge_request! ( merge_request )
forbidden! ( 'Source branch does not exist' ) unless
merge_request . source_branch_exists?
user_access = Gitlab :: UserAccess . new (
current_user ,
2020-07-21 14:09:45 -04:00
container : merge_request . source_project
2018-11-22 01:02:58 -05:00
)
forbidden! ( 'Cannot push to source branch' ) unless
user_access . can_push_to_branch? ( merge_request . source_branch )
2022-02-10 13:18:16 -05:00
forbidden! ( 'Source branch is protected from force push' ) unless
merge_request . permits_force_push?
2018-11-22 01:02:58 -05:00
end
2017-07-24 16:07:37 -04:00
params :merge_requests_params do
2020-01-13 16:07:39 -05:00
use :merge_requests_base_params
2019-03-07 18:55:45 -05:00
use :optional_merge_requests_search_params
2017-07-24 16:07:37 -04:00
use :pagination
end
end
resource :merge_requests do
desc 'List merge requests' do
success Entities :: MergeRequestBasic
end
params do
use :merge_requests_params
2020-01-13 16:07:39 -05:00
use :optional_scope_param
2017-07-24 16:07:37 -04:00
end
2021-12-08 07:13:04 -05:00
get feature_category : :code_review , urgency : :low do
2017-09-18 13:29:17 -04:00
authenticate! unless params [ :scope ] == 'all'
2021-09-21 11:12:11 -04:00
validate_anonymous_search_access! if params [ :search ] . present?
2017-07-24 16:07:37 -04:00
merge_requests = find_merge_requests
2018-05-31 11:29:07 -04:00
present merge_requests , serializer_options_for ( merge_requests )
end
end
2017-07-24 16:07:37 -04:00
2018-05-31 11:29:07 -04:00
params do
requires :id , type : String , desc : 'The ID of a group'
end
2018-11-08 07:18:17 -05:00
resource :groups , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2018-05-31 11:29:07 -04:00
desc 'Get a list of group merge requests' do
success Entities :: MergeRequestBasic
end
params do
use :merge_requests_params
2020-02-05 13:09:06 -05:00
optional :non_archived , type : Boolean , desc : 'Return merge requests from non archived projects' ,
default : true
2018-05-31 11:29:07 -04:00
end
2021-12-08 07:13:04 -05:00
get " :id/merge_requests " , feature_category : :code_review , urgency : :low do
2021-09-21 11:12:11 -04:00
validate_anonymous_search_access! if declared_params [ :search ] . present?
2019-12-27 10:08:16 -05:00
merge_requests = find_merge_requests ( group_id : user_group . id , include_subgroups : true )
2017-07-24 16:07:37 -04:00
2019-12-27 10:08:16 -05:00
present merge_requests , serializer_options_for ( merge_requests ) . merge ( group : user_group )
2017-07-24 16:07:37 -04:00
end
end
2016-11-08 03:28:52 -05:00
params do
requires :id , type : String , desc : 'The ID of a project'
end
2018-11-08 07:18:17 -05:00
resource :projects , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-01-18 11:48:16 -05:00
include TimeTrackingEndpoints
2013-02-05 12:36:36 -05:00
helpers do
2018-03-05 12:30:05 -05:00
params :optional_params do
2016-11-08 03:28:52 -05:00
optional :assignee_id , type : Integer , desc : 'The ID of a user to assign the merge request'
2021-01-21 04:08:52 -05:00
optional :assignee_ids , type : Array [ Integer ] , coerce_with : :: API :: Validations :: Types :: CommaSeparatedToIntegerArray . coerce , desc : 'Comma-separated list of assignee ids'
optional :reviewer_ids , type : Array [ Integer ] , coerce_with : :: API :: Validations :: Types :: CommaSeparatedToIntegerArray . coerce , desc : 'Comma-separated list of reviewer ids'
2020-09-14 17:09:27 -04:00
optional :description , type : String , desc : 'The description of the merge request'
2020-06-29 17:09:07 -04:00
optional :labels , type : Array [ String ] , coerce_with : Validations :: Types :: CommaSeparatedToArray . coerce , desc : 'Comma-separated list of label names'
optional :add_labels , type : Array [ String ] , coerce_with : Validations :: Types :: CommaSeparatedToArray . coerce , desc : 'Comma-separated list of label names'
optional :remove_labels , type : Array [ String ] , coerce_with : Validations :: Types :: CommaSeparatedToArray . coerce , desc : 'Comma-separated list of label names'
2020-09-14 17:09:27 -04:00
optional :milestone_id , type : Integer , desc : 'The ID of a milestone to assign the merge request'
2018-06-15 18:05:24 -04:00
optional :remove_source_branch , type : Boolean , desc : 'Remove source branch when merging'
2018-05-22 21:54:57 -04:00
optional :allow_collaboration , type : Boolean , desc : 'Allow commits from members who can merge to the target branch'
optional :allow_maintainer_to_push , type : Boolean , as : :allow_collaboration , desc : '[deprecated] See allow_collaboration'
2018-05-29 05:51:43 -04:00
optional :squash , type : Grape :: API :: Boolean , desc : 'When true, the commits will be squashed into a single commit on merge'
2017-04-05 12:31:15 -04:00
2018-03-05 12:30:05 -05:00
use :optional_params_ee
2017-04-05 12:31:15 -04:00
end
2013-02-05 12:36:36 -05:00
end
2016-11-08 03:28:52 -05:00
desc 'List merge requests' do
2017-03-06 06:48:10 -05:00
success Entities :: MergeRequestBasic
2016-11-08 03:28:52 -05:00
end
params do
2017-07-24 16:07:37 -04:00
use :merge_requests_params
2020-06-29 17:09:07 -04:00
optional :iids , type : Array [ Integer ] , coerce_with : :: API :: Validations :: Types :: CommaSeparatedToIntegerArray . coerce , desc : 'The IID array of merge requests'
2016-11-08 03:28:52 -05:00
end
2021-12-08 07:13:04 -05:00
get " :id/merge_requests " , feature_category : :code_review , urgency : :low do
2012-10-21 09:13:39 -04:00
authorize! :read_merge_request , user_project
2021-09-21 11:12:11 -04:00
validate_anonymous_search_access! if declared_params [ :search ] . present?
2012-11-29 15:10:07 -05:00
2017-04-25 10:56:32 -04:00
merge_requests = find_merge_requests ( project_id : user_project . id )
2014-09-09 11:39:53 -04:00
2019-12-27 10:08:16 -05:00
options = serializer_options_for ( merge_requests ) . merge ( project : user_project )
2018-05-31 11:29:07 -04:00
options [ :project ] = user_project
2017-07-10 17:58:23 -04:00
2022-02-16 10:14:05 -05:00
present_cached merge_requests , expires_in : 2 . days , ** options
2012-10-21 07:00:27 -04:00
end
2012-11-29 15:10:07 -05:00
2016-11-08 03:28:52 -05:00
desc 'Create a merge request' do
success Entities :: MergeRequest
end
params do
requires :title , type : String , desc : 'The title of the merge request'
requires :source_branch , type : String , desc : 'The source branch'
requires :target_branch , type : String , desc : 'The target branch'
optional :target_project_id , type : Integer ,
desc : 'The target project of the merge request defaults to the :id of the project'
use :optional_params
end
2021-12-08 07:13:04 -05:00
post " :id/merge_requests " , feature_category : :code_review , urgency : :low do
2021-03-24 23:09:35 -04:00
Gitlab :: QueryLimiting . disable! ( 'https://gitlab.com/gitlab-org/gitlab/-/issues/20770' )
2018-01-15 10:21:04 -05:00
2018-04-06 13:58:53 -04:00
authorize! :create_merge_request_from , user_project
2016-11-08 03:28:52 -05:00
2016-11-28 15:33:12 -05:00
mr_params = declared_params ( include_missing : false )
2017-06-14 16:38:27 -04:00
mr_params [ :force_remove_source_branch ] = mr_params . delete ( :remove_source_branch )
2019-04-07 14:35:16 -04:00
mr_params = convert_parameters_from_legacy_format ( mr_params )
2014-08-14 04:17:52 -04:00
2021-05-11 23:10:21 -04:00
merge_request = :: MergeRequests :: CreateService . new ( project : user_project , current_user : current_user , params : mr_params ) . execute
2013-07-17 11:23:36 -04:00
2020-07-17 20:09:34 -04:00
handle_merge_request_errors! ( merge_request )
2020-11-26 10:09:30 -05:00
Gitlab :: UsageDataCounters :: EditorUniqueCounter . track_sse_edit_action ( author : current_user ) if request_from_sse? ( user_project )
2020-07-17 20:09:34 -04:00
present merge_request , with : Entities :: MergeRequest , current_user : current_user , project : user_project
2012-10-21 07:00:27 -04:00
end
2016-11-08 03:28:52 -05:00
desc 'Delete a merge request'
params do
2017-02-25 07:25:32 -05:00
requires :merge_request_iid , type : Integer , desc : 'The IID of a merge request'
2016-11-08 03:28:52 -05:00
end
2021-12-08 07:13:04 -05:00
delete " :id/merge_requests/:merge_request_iid " , feature_category : :code_review , urgency : :low do
2017-02-25 07:25:32 -05:00
merge_request = find_project_merge_request ( params [ :merge_request_iid ] )
2016-03-18 14:11:25 -04:00
2016-03-21 09:12:52 -04:00
authorize! ( :destroy_merge_request , merge_request )
2017-03-01 08:35:48 -05:00
2017-11-25 10:04:45 -05:00
destroy_conditionally! ( merge_request ) do | merge_request |
2021-05-11 23:10:21 -04:00
Issuable :: DestroyService . new ( project : user_project , current_user : current_user ) . execute ( merge_request )
2017-11-25 10:04:45 -05:00
end
2016-02-26 03:55:43 -05:00
end
2016-11-08 03:28:52 -05:00
params do
2017-02-25 07:25:32 -05:00
requires :merge_request_iid , type : Integer , desc : 'The IID of a merge request'
2018-07-04 05:35:39 -04:00
optional :render_html , type : Boolean , desc : 'Returns the description and title rendered HTML'
2018-09-05 09:07:02 -04:00
optional :include_diverged_commits_count , type : Boolean , desc : 'Returns the commits count behind the target branch'
2018-11-28 07:57:47 -05:00
optional :include_rebase_in_progress , type : Boolean , desc : 'Returns whether a rebase operation is ongoing '
2016-11-08 03:28:52 -05:00
end
2017-01-25 16:35:27 -05:00
desc 'Get a single merge request' do
success Entities :: MergeRequest
end
2021-12-08 07:13:04 -05:00
get ':id/merge_requests/:merge_request_iid' , feature_category : :code_review , urgency : :low do
2017-02-25 07:25:32 -05:00
merge_request = find_merge_request_with_access ( params [ :merge_request_iid ] )
2017-01-03 13:03:13 -05:00
2018-11-28 07:57:47 -05:00
present merge_request ,
with : Entities :: MergeRequest ,
current_user : current_user ,
project : user_project ,
render_html : params [ :render_html ] ,
2020-04-21 11:21:10 -04:00
include_first_contribution : true ,
2018-11-28 07:57:47 -05:00
include_diverged_commits_count : params [ :include_diverged_commits_count ] ,
include_rebase_in_progress : params [ :include_rebase_in_progress ]
2017-01-25 16:35:27 -05:00
end
2014-05-12 09:34:41 -04:00
2018-01-05 10:21:53 -05:00
desc 'Get the participants of a merge request' do
success Entities :: UserBasic
end
2021-12-08 07:13:04 -05:00
get ':id/merge_requests/:merge_request_iid/participants' , feature_category : :code_review , urgency : :low do
2018-01-05 10:21:53 -05:00
merge_request = find_merge_request_with_access ( params [ :merge_request_iid ] )
2021-02-11 10:09:11 -05:00
2021-12-08 19:13:41 -05:00
participants = :: Kaminari . paginate_array ( merge_request . visible_participants ( current_user ) )
2018-01-05 10:21:53 -05:00
present paginate ( participants ) , with : Entities :: UserBasic
end
2017-01-25 16:35:27 -05:00
desc 'Get the commits of a merge request' do
2017-10-05 04:48:05 -04:00
success Entities :: Commit
2017-01-25 16:35:27 -05:00
end
2021-12-08 07:13:04 -05:00
get ':id/merge_requests/:merge_request_iid/commits' , feature_category : :code_review , urgency : :low do
2017-02-25 07:25:32 -05:00
merge_request = find_merge_request_with_access ( params [ :merge_request_iid ] )
2017-01-03 13:03:13 -05:00
2019-11-08 16:06:38 -05:00
commits =
paginate ( merge_request . merge_request_diff . merge_request_diff_commits )
. map { | commit | Commit . from_hash ( commit . to_hash , merge_request . project ) }
present commits , with : Entities :: Commit
2017-01-25 16:35:27 -05:00
end
2015-11-18 05:17:41 -05:00
2020-01-29 10:08:59 -05:00
desc 'Get the context commits of a merge request' do
2020-01-30 10:09:15 -05:00
success Entities :: Commit
2020-01-29 10:08:59 -05:00
end
2021-12-07 07:10:33 -05:00
get ':id/merge_requests/:merge_request_iid/context_commits' , feature_category : :code_review , urgency : :high do
2020-01-29 10:08:59 -05:00
merge_request = find_merge_request_with_access ( params [ :merge_request_iid ] )
2020-01-30 10:09:15 -05:00
context_commits =
paginate ( merge_request . merge_request_context_commits ) . map ( & :to_commit )
2020-03-23 11:09:36 -04:00
present context_commits , with : Entities :: CommitWithLink , type : :full , request : merge_request
2020-01-29 10:08:59 -05:00
end
params do
2020-06-29 17:09:07 -04:00
requires :commits , type : Array [ String ] , coerce_with : :: API :: Validations :: Types :: CommaSeparatedToArray . coerce , allow_blank : false , desc : 'List of context commits sha'
2020-01-29 10:08:59 -05:00
end
desc 'create context commits of merge request' do
success Entities :: Commit
end
2021-04-12 11:09:30 -04:00
post ':id/merge_requests/:merge_request_iid/context_commits' , feature_category : :code_review do
2020-01-29 10:08:59 -05:00
commit_ids = params [ :commits ]
if commit_ids . size > CONTEXT_COMMITS_POST_LIMIT
render_api_error! ( " Context commits array size should not be more than #{ CONTEXT_COMMITS_POST_LIMIT } " , 400 )
end
merge_request = find_merge_request_with_access ( params [ :merge_request_iid ] )
authorize! ( :update_merge_request , merge_request )
project = merge_request . target_project
2021-05-11 23:10:21 -04:00
result = :: MergeRequests :: AddContextService . new ( project : project , current_user : current_user , params : { merge_request : merge_request , commits : commit_ids } ) . execute
2020-01-29 10:08:59 -05:00
if result . instance_of? ( Array )
present result , with : Entities :: Commit
else
render_api_error! ( result [ :message ] , result [ :http_status ] )
end
end
params do
2020-06-29 17:09:07 -04:00
requires :commits , type : Array [ String ] , coerce_with : :: API :: Validations :: Types :: CommaSeparatedToArray . coerce , allow_blank : false , desc : 'List of context commits sha'
2020-01-29 10:08:59 -05:00
end
desc 'remove context commits of merge request'
2021-04-12 11:09:30 -04:00
delete ':id/merge_requests/:merge_request_iid/context_commits' , feature_category : :code_review do
2020-01-29 10:08:59 -05:00
commit_ids = params [ :commits ]
merge_request = find_merge_request_with_access ( params [ :merge_request_iid ] )
authorize! ( :destroy_merge_request , merge_request )
project = merge_request . target_project
commits = project . repository . commits_by ( oids : commit_ids )
if commits . size != commit_ids . size
render_api_error! ( " One or more context commits' sha is not valid. " , 400 )
end
MergeRequestContextCommit . delete_bulk ( merge_request , commits )
status 204
end
2017-01-25 16:35:27 -05:00
desc 'Show the merge request changes' do
success Entities :: MergeRequestChanges
end
2021-12-08 07:13:04 -05:00
get ':id/merge_requests/:merge_request_iid/changes' , feature_category : :code_review , urgency : :low do
2017-02-25 07:25:32 -05:00
merge_request = find_merge_request_with_access ( params [ :merge_request_iid ] )
2017-01-03 13:03:13 -05:00
2020-11-11 22:09:17 -05:00
present merge_request ,
with : Entities :: MergeRequestChanges ,
current_user : current_user ,
project : user_project ,
2021-02-03 19:09:18 -05:00
access_raw_diffs : to_boolean ( params . fetch ( :access_raw_diffs , false ) )
2017-01-25 16:35:27 -05:00
end
2014-05-12 09:34:41 -04:00
2017-11-16 13:10:15 -05:00
desc 'Get the merge request pipelines' do
2020-08-13 14:10:36 -04:00
success Entities :: Ci :: PipelineBasic
2017-11-16 13:10:15 -05:00
end
2021-04-12 11:09:30 -04:00
get ':id/merge_requests/:merge_request_iid/pipelines' , feature_category : :continuous_integration do
2017-11-16 13:10:15 -05:00
pipelines = merge_request_pipelines_with_access
2020-08-13 14:10:36 -04:00
present paginate ( pipelines ) , with : Entities :: Ci :: PipelineBasic
2017-11-16 13:10:15 -05:00
end
2019-09-11 05:06:33 -04:00
desc 'Create a pipeline for merge request' do
2020-08-13 14:10:36 -04:00
success :: API :: Entities :: Ci :: Pipeline
2019-09-11 05:06:33 -04:00
end
2021-04-12 11:09:30 -04:00
post ':id/merge_requests/:merge_request_iid/pipelines' , feature_category : :continuous_integration do
2019-09-11 05:06:33 -04:00
pipeline = :: MergeRequests :: CreatePipelineService
2021-05-11 23:10:21 -04:00
. new ( project : user_project , current_user : current_user , params : { allow_duplicate : true } )
2019-09-11 05:06:33 -04:00
. execute ( find_merge_request_with_access ( params [ :merge_request_iid ] ) )
2021-07-20 08:10:29 -04:00
. payload
2019-09-11 05:06:33 -04:00
if pipeline . nil?
not_allowed!
elsif pipeline . persisted?
status :ok
2020-08-13 14:10:36 -04:00
present pipeline , with : :: API :: Entities :: Ci :: Pipeline
2019-09-11 05:06:33 -04:00
else
render_validation_error! ( pipeline )
end
end
2017-01-25 16:35:27 -05:00
desc 'Update a merge request' do
success Entities :: MergeRequest
end
params do
optional :title , type : String , allow_blank : false , desc : 'The title of the merge request'
optional :target_branch , type : String , allow_blank : false , desc : 'The target branch'
2016-12-13 16:45:09 -05:00
optional :state_event , type : String , values : %w[ close reopen ] ,
2017-01-25 16:35:27 -05:00
desc : 'Status of the merge request'
2017-08-31 06:38:32 -04:00
optional :discussion_locked , type : Boolean , desc : 'Whether the MR discussion is locked'
2017-04-05 12:31:15 -04:00
2017-01-25 16:35:27 -05:00
use :optional_params
2018-03-05 12:30:05 -05:00
at_least_one_of ( * :: API :: MergeRequests . update_params_at_least_one_of )
2017-01-25 16:35:27 -05:00
end
2021-12-08 07:13:04 -05:00
put ':id/merge_requests/:merge_request_iid' , feature_category : :code_review , urgency : :low do
2021-03-24 23:09:35 -04:00
Gitlab :: QueryLimiting . disable! ( 'https://gitlab.com/gitlab-org/gitlab/-/issues/20772' )
2018-01-15 10:21:04 -05:00
2017-02-25 07:25:32 -05:00
merge_request = find_merge_request_with_access ( params . delete ( :merge_request_iid ) , :update_merge_request )
2016-01-28 08:26:02 -05:00
2017-01-25 16:35:27 -05:00
mr_params = declared_params ( include_missing : false )
2019-04-15 13:55:45 -04:00
mr_params [ :force_remove_source_branch ] = mr_params . delete ( :remove_source_branch ) if mr_params . has_key? ( :remove_source_branch )
2019-04-07 14:35:16 -04:00
mr_params = convert_parameters_from_legacy_format ( mr_params )
2021-05-20 11:10:13 -04:00
mr_params [ :use_specialized_service ] = true
2015-11-18 05:17:41 -05:00
2021-05-20 11:10:13 -04:00
merge_request = :: MergeRequests :: UpdateService
. new ( project : user_project , current_user : current_user , params : mr_params )
. execute ( merge_request )
2014-05-12 09:34:41 -04:00
2020-07-17 20:09:34 -04:00
handle_merge_request_errors! ( merge_request )
present merge_request , with : Entities :: MergeRequest , current_user : current_user , project : user_project
2017-01-25 16:35:27 -05:00
end
2014-03-19 14:07:51 -04:00
2017-01-25 16:35:27 -05:00
desc 'Merge a merge request' do
success Entities :: MergeRequest
end
params do
optional :merge_commit_message , type : String , desc : 'Custom merge commit message'
2019-01-29 20:29:33 -05:00
optional :squash_commit_message , type : String , desc : 'Custom squash commit message'
2017-01-25 16:35:27 -05:00
optional :should_remove_source_branch , type : Boolean ,
desc : 'When true, the source branch will be deleted if possible'
2017-02-17 08:56:13 -05:00
optional :merge_when_pipeline_succeeds , type : Boolean ,
desc : 'When true, this merge request will be merged when the pipeline succeeds'
2017-01-25 16:35:27 -05:00
optional :sha , type : String , desc : 'When present, must have the HEAD SHA of the source branch'
2018-05-29 05:51:43 -04:00
optional :squash , type : Grape :: API :: Boolean , desc : 'When true, the commits will be squashed into a single commit on merge'
2017-01-25 16:35:27 -05:00
end
2021-12-08 07:13:04 -05:00
put ':id/merge_requests/:merge_request_iid/merge' , feature_category : :code_review , urgency : :low do
2021-03-24 23:09:35 -04:00
Gitlab :: QueryLimiting . disable! ( 'https://gitlab.com/gitlab-org/gitlab/-/issues/4796' )
2018-01-15 10:21:04 -05:00
2017-02-25 07:25:32 -05:00
merge_request = find_project_merge_request ( params [ :merge_request_iid ] )
2016-01-28 08:26:02 -05:00
2017-01-25 16:35:27 -05:00
# Merge request can not be merged
# because user dont have permissions to push into target branch
unauthorized! unless merge_request . can_be_merged_by? ( current_user )
2016-01-28 08:26:02 -05:00
2020-01-13 13:08:05 -05:00
merge_when_pipeline_succeeds = to_boolean ( params [ :merge_when_pipeline_succeeds ] )
automatically_mergeable = automatically_mergeable? ( merge_when_pipeline_succeeds , merge_request )
immediately_mergeable = immediately_mergeable? ( merge_when_pipeline_succeeds , merge_request )
not_allowed! if ! immediately_mergeable && ! automatically_mergeable
2016-01-28 08:26:02 -05:00
2022-04-07 23:09:41 -04:00
render_api_error! ( 'Branch cannot be merged' , 406 ) unless merge_request . mergeable? ( skip_ci_check : automatically_mergeable )
2016-01-28 08:26:02 -05:00
2018-03-05 12:30:05 -05:00
check_sha_param! ( params , merge_request )
2018-05-29 05:51:43 -04:00
merge_request . update ( squash : params [ :squash ] ) if params [ :squash ]
2016-06-01 05:21:22 -04:00
2019-02-25 08:59:17 -05:00
merge_params = HashWithIndifferentAccess . new (
2017-01-25 16:35:27 -05:00
commit_message : params [ :merge_commit_message ] ,
2019-01-29 20:29:33 -05:00
squash_commit_message : params [ :squash_commit_message ] ,
2019-11-15 10:06:12 -05:00
should_remove_source_branch : params [ :should_remove_source_branch ] ,
sha : params [ :sha ] || merge_request . diff_head_sha
2020-06-04 11:08:21 -04:00
) . compact
2014-03-19 14:07:51 -04:00
2020-01-13 13:08:05 -05:00
if immediately_mergeable
2017-01-25 16:35:27 -05:00
:: MergeRequests :: MergeService
2021-05-11 23:10:21 -04:00
. new ( project : merge_request . target_project , current_user : current_user , params : merge_params )
2017-01-25 16:35:27 -05:00
. execute ( merge_request )
2020-01-13 13:08:05 -05:00
elsif automatically_mergeable
AutoMergeService . new ( merge_request . target_project , current_user , merge_params )
. execute ( merge_request , AutoMergeService :: STRATEGY_MERGE_WHEN_PIPELINE_SUCCEEDS )
2016-01-28 08:26:02 -05:00
end
2013-02-27 09:07:42 -05:00
2017-01-25 16:35:27 -05:00
present merge_request , with : Entities :: MergeRequest , current_user : current_user , project : user_project
end
2015-10-09 12:14:35 -04:00
2019-05-21 17:14:22 -04:00
desc 'Returns the up to date merge-ref HEAD commit'
2021-04-12 11:09:30 -04:00
get ':id/merge_requests/:merge_request_iid/merge_ref' , feature_category : :code_review do
2019-02-08 16:25:26 -05:00
merge_request = find_project_merge_request ( params [ :merge_request_iid ] )
2019-05-21 17:14:22 -04:00
result = :: MergeRequests :: MergeabilityCheckService . new ( merge_request ) . execute ( recheck : true )
2019-02-08 16:25:26 -05:00
2019-05-21 17:14:22 -04:00
if result . success?
present :commit_id , result . payload . dig ( :merge_ref_head , :commit_id )
2019-02-08 16:25:26 -05:00
else
2019-05-21 17:14:22 -04:00
render_api_error! ( result . message , 400 )
2019-02-08 16:25:26 -05:00
end
end
2017-01-25 16:35:27 -05:00
desc 'Cancel merge if "Merge When Pipeline Succeeds" is enabled' do
success Entities :: MergeRequest
end
2021-04-12 11:09:30 -04:00
post ':id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds' , feature_category : :code_review do
2017-02-25 07:25:32 -05:00
merge_request = find_project_merge_request ( params [ :merge_request_iid ] )
2015-10-09 12:14:35 -04:00
2019-05-22 07:45:27 -04:00
unauthorized! unless merge_request . can_cancel_auto_merge? ( current_user )
2015-10-09 12:14:35 -04:00
2019-05-22 07:45:27 -04:00
AutoMergeService . new ( merge_request . target_project , current_user ) . cancel ( merge_request )
2017-01-25 16:35:27 -05:00
end
2012-10-25 06:38:55 -04:00
2018-11-22 01:02:58 -05:00
desc 'Rebase the merge request against its target branch' do
detail 'This feature was added in GitLab 11.6'
end
2020-01-16 16:08:24 -05:00
params do
optional :skip_ci , type : Boolean , desc : 'Do not create CI pipeline'
end
2021-12-08 07:13:04 -05:00
put ':id/merge_requests/:merge_request_iid/rebase' , feature_category : :code_review , urgency : :low do
2018-11-22 01:02:58 -05:00
merge_request = find_project_merge_request ( params [ :merge_request_iid ] )
authorize_push_to_merge_request! ( merge_request )
2020-01-16 16:08:24 -05:00
merge_request . rebase_async ( current_user . id , skip_ci : params [ :skip_ci ] )
2018-11-22 01:02:58 -05:00
status :accepted
2019-06-21 12:56:47 -04:00
present rebase_in_progress : merge_request . rebase_in_progress?
2019-10-21 20:06:05 -04:00
rescue :: MergeRequest :: RebaseLockTimeout = > e
render_api_error! ( e . message , 409 )
2018-11-22 01:02:58 -05:00
end
2017-01-25 16:35:27 -05:00
desc 'List issues that will be closed on merge' do
success Entities :: MRNote
end
params do
use :pagination
end
2021-12-08 07:13:04 -05:00
get ':id/merge_requests/:merge_request_iid/closes_issues' , feature_category : :code_review , urgency : :low do
2017-02-25 07:25:32 -05:00
merge_request = find_merge_request_with_access ( params [ :merge_request_iid ] )
2018-07-30 14:52:42 -04:00
issues = :: Kaminari . paginate_array ( merge_request . visible_closing_issues_for ( current_user ) )
2017-07-10 03:38:42 -04:00
issues = paginate ( issues )
external_issues , internal_issues = issues . partition { | issue | issue . is_a? ( ExternalIssue ) }
data = Entities :: IssueBasic . represent ( internal_issues , current_user : current_user )
data += Entities :: ExternalIssue . represent ( external_issues , current_user : current_user )
data . as_json
2017-01-25 16:35:27 -05:00
end
2012-10-21 07:00:27 -04:00
end
end
end