summaryrefslogtreecommitdiff
path: root/lib/api/merge_requests.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/api/merge_requests.rb')
-rw-r--r--lib/api/merge_requests.rb192
1 files changed, 96 insertions, 96 deletions
diff --git a/lib/api/merge_requests.rb b/lib/api/merge_requests.rb
index 44f1e81caf2..71a61f38864 100644
--- a/lib/api/merge_requests.rb
+++ b/lib/api/merge_requests.rb
@@ -38,11 +38,11 @@ module API
args[:scope] = args[:scope].underscore if args[:scope]
merge_requests = MergeRequestsFinder.new(current_user, args).execute
- .reorder(order_options_with_tie_breaker)
+ .reorder(order_options_with_tie_breaker)
merge_requests = paginate(merge_requests)
- .preload(:source_project, :target_project)
+ .preload(:source_project, :target_project)
- return merge_requests if args[:view] == 'simple'
+ return merge_requests if args[:view] == "simple"
merge_requests
.preload(:notes, :author, :assignee, :milestone, :latest_merge_request_diff, :labels, :timelogs, metrics: [:latest_closed_by, :merged_by])
@@ -63,19 +63,19 @@ module API
end
def serializer_options_for(merge_requests)
- options = { with: Entities::MergeRequestBasic, current_user: current_user }
+ options = {with: Entities::MergeRequestBasic, current_user: current_user}
- if params[:view] == 'simple'
+ if params[:view] == "simple"
options[:with] = Entities::MergeRequestSimple
else
- options[:issuable_metadata] = issuable_meta_data(merge_requests, 'MergeRequest')
+ options[:issuable_metadata] = issuable_meta_data(merge_requests, "MergeRequest")
end
options
end
def authorize_push_to_merge_request!(merge_request)
- forbidden!('Source branch does not exist') unless
+ forbidden!("Source branch does not exist") unless
merge_request.source_branch_exists?
user_access = Gitlab::UserAccess.new(
@@ -83,50 +83,50 @@ module API
project: merge_request.source_project
)
- forbidden!('Cannot push to source branch') unless
+ forbidden!("Cannot push to source branch") unless
user_access.can_push_to_branch?(merge_request.source_branch)
end
params :merge_requests_params do
- optional :state, type: String, values: %w[opened closed locked merged all], default: 'all',
- desc: 'Return opened, closed, locked, merged, or all merge requests'
- optional :order_by, type: String, values: %w[created_at updated_at], default: 'created_at',
- desc: 'Return merge requests ordered by `created_at` or `updated_at` fields.'
- optional :sort, type: String, values: %w[asc desc], default: 'desc',
- desc: 'Return merge requests sorted in `asc` or `desc` order.'
- optional :milestone, type: String, desc: 'Return merge requests for a specific milestone'
- optional :labels, type: String, desc: 'Comma-separated list of label names'
- optional :created_after, type: DateTime, desc: 'Return merge requests created after the specified time'
- optional :created_before, type: DateTime, desc: 'Return merge requests created before the specified time'
- optional :updated_after, type: DateTime, desc: 'Return merge requests updated after the specified time'
- optional :updated_before, type: DateTime, desc: 'Return merge requests updated before the specified time'
- optional :view, type: String, values: %w[simple], desc: 'If simple, returns the `iid`, URL, title, description, and basic state of merge request'
- optional :author_id, type: Integer, desc: 'Return merge requests which are authored by the user with the given ID'
+ optional :state, type: String, values: %w[opened closed locked merged all], default: "all",
+ desc: "Return opened, closed, locked, merged, or all merge requests"
+ optional :order_by, type: String, values: %w[created_at updated_at], default: "created_at",
+ desc: "Return merge requests ordered by `created_at` or `updated_at` fields."
+ optional :sort, type: String, values: %w[asc desc], default: "desc",
+ desc: "Return merge requests sorted in `asc` or `desc` order."
+ optional :milestone, type: String, desc: "Return merge requests for a specific milestone"
+ optional :labels, type: String, desc: "Comma-separated list of label names"
+ optional :created_after, type: DateTime, desc: "Return merge requests created after the specified time"
+ optional :created_before, type: DateTime, desc: "Return merge requests created before the specified time"
+ optional :updated_after, type: DateTime, desc: "Return merge requests updated after the specified time"
+ optional :updated_before, type: DateTime, desc: "Return merge requests updated before the specified time"
+ optional :view, type: String, values: %w[simple], desc: "If simple, returns the `iid`, URL, title, description, and basic state of merge request"
+ optional :author_id, type: Integer, desc: "Return merge requests which are authored by the user with the given ID"
optional :assignee_id, types: [Integer, String], integer_none_any: true,
- desc: 'Return merge requests which are assigned to the user with the given ID'
+ desc: "Return merge requests which are assigned to the user with the given ID"
optional :scope, type: String, values: %w[created-by-me assigned-to-me created_by_me assigned_to_me all],
- desc: 'Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`'
- optional :my_reaction_emoji, type: String, desc: 'Return issues reacted by the authenticated user by the given emoji'
- optional :source_branch, type: String, desc: 'Return merge requests with the given source branch'
- optional :target_branch, type: String, desc: 'Return merge requests with the given target branch'
- optional :search, type: String, desc: 'Search merge requests for text present in the title, description, or any combination of these'
- optional :in, type: String, desc: '`title`, `description`, or a string joining them with comma'
- optional :wip, type: String, values: %w[yes no], desc: 'Search merge requests for WIP in the title'
+ desc: "Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`"
+ optional :my_reaction_emoji, type: String, desc: "Return issues reacted by the authenticated user by the given emoji"
+ optional :source_branch, type: String, desc: "Return merge requests with the given source branch"
+ optional :target_branch, type: String, desc: "Return merge requests with the given target branch"
+ optional :search, type: String, desc: "Search merge requests for text present in the title, description, or any combination of these"
+ optional :in, type: String, desc: "`title`, `description`, or a string joining them with comma"
+ optional :wip, type: String, values: %w[yes no], desc: "Search merge requests for WIP in the title"
use :pagination
end
end
resource :merge_requests do
- desc 'List merge requests' do
+ desc "List merge requests" do
success Entities::MergeRequestBasic
end
params do
use :merge_requests_params
- optional :scope, type: String, values: %w[created-by-me assigned-to-me created_by_me assigned_to_me all], default: 'created_by_me',
- desc: 'Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`'
+ optional :scope, type: String, values: %w[created-by-me assigned-to-me created_by_me assigned_to_me all], default: "created_by_me",
+ desc: "Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`"
end
get do
- authenticate! unless params[:scope] == 'all'
+ authenticate! unless params[:scope] == "all"
merge_requests = find_merge_requests
present merge_requests, serializer_options_for(merge_requests)
@@ -134,10 +134,10 @@ module API
end
params do
- requires :id, type: String, desc: 'The ID of a group'
+ requires :id, type: String, desc: "The ID of a group"
end
resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
- desc 'Get a list of group merge requests' do
+ desc "Get a list of group merge requests" do
success Entities::MergeRequestBasic
end
params do
@@ -153,7 +153,7 @@ module API
end
params do
- requires :id, type: String, desc: 'The ID of a project'
+ requires :id, type: String, desc: "The ID of a project"
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
include TimeTrackingEndpoints
@@ -176,25 +176,25 @@ module API
end
params :optional_params do
- optional :description, type: String, desc: 'The description of the merge request'
- optional :assignee_id, type: Integer, desc: 'The ID of a user to assign the merge request'
- optional :milestone_id, type: Integer, desc: 'The ID of a milestone to assign the merge request'
- optional :labels, type: String, desc: 'Comma-separated list of label names'
- optional :remove_source_branch, type: Boolean, desc: 'Delete source branch when merging'
- 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'
- optional :squash, type: Grape::API::Boolean, desc: 'When true, the commits will be squashed into a single commit on merge'
+ optional :description, type: String, desc: "The description of the merge request"
+ optional :assignee_id, type: Integer, desc: "The ID of a user to assign the merge request"
+ optional :milestone_id, type: Integer, desc: "The ID of a milestone to assign the merge request"
+ optional :labels, type: String, desc: "Comma-separated list of label names"
+ optional :remove_source_branch, type: Boolean, desc: "Delete source branch when merging"
+ 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"
+ optional :squash, type: Grape::API::Boolean, desc: "When true, the commits will be squashed into a single commit on merge"
use :optional_params_ee
end
end
- desc 'List merge requests' do
+ desc "List merge requests" do
success Entities::MergeRequestBasic
end
params do
use :merge_requests_params
- optional :iids, type: Array[Integer], desc: 'The IID array of merge requests'
+ optional :iids, type: Array[Integer], desc: "The IID array of merge requests"
end
get ":id/merge_requests" do
authorize! :read_merge_request, user_project
@@ -207,19 +207,19 @@ module API
present merge_requests, options
end
- desc 'Create a merge request' do
+ 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'
+ 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'
+ desc: "The target project of the merge request defaults to the :id of the project"
use :optional_params
end
post ":id/merge_requests" do
- Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42316')
+ Gitlab::QueryLimiting.whitelist("https://gitlab.com/gitlab-org/gitlab-ce/issues/42316")
authorize! :create_merge_request_from, user_project
@@ -235,9 +235,9 @@ module API
end
end
- desc 'Delete a merge request'
+ desc "Delete a merge request"
params do
- requires :merge_request_iid, type: Integer, desc: 'The IID of a merge request'
+ requires :merge_request_iid, type: Integer, desc: "The IID of a merge request"
end
delete ":id/merge_requests/:merge_request_iid" do
merge_request = find_project_merge_request(params[:merge_request_iid])
@@ -250,15 +250,15 @@ module API
end
params do
- requires :merge_request_iid, type: Integer, desc: 'The IID of a merge request'
- optional :render_html, type: Boolean, desc: 'Returns the description and title rendered HTML'
- optional :include_diverged_commits_count, type: Boolean, desc: 'Returns the commits count behind the target branch'
- optional :include_rebase_in_progress, type: Boolean, desc: 'Returns whether a rebase operation is ongoing '
+ requires :merge_request_iid, type: Integer, desc: "The IID of a merge request"
+ optional :render_html, type: Boolean, desc: "Returns the description and title rendered HTML"
+ optional :include_diverged_commits_count, type: Boolean, desc: "Returns the commits count behind the target branch"
+ optional :include_rebase_in_progress, type: Boolean, desc: "Returns whether a rebase operation is ongoing "
end
- desc 'Get a single merge request' do
+ desc "Get a single merge request" do
success Entities::MergeRequest
end
- get ':id/merge_requests/:merge_request_iid' do
+ get ":id/merge_requests/:merge_request_iid" do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
present merge_request,
@@ -270,59 +270,59 @@ module API
include_rebase_in_progress: params[:include_rebase_in_progress]
end
- desc 'Get the participants of a merge request' do
+ desc "Get the participants of a merge request" do
success Entities::UserBasic
end
- get ':id/merge_requests/:merge_request_iid/participants' do
+ get ":id/merge_requests/:merge_request_iid/participants" do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
participants = ::Kaminari.paginate_array(merge_request.participants)
present paginate(participants), with: Entities::UserBasic
end
- desc 'Get the commits of a merge request' do
+ desc "Get the commits of a merge request" do
success Entities::Commit
end
- get ':id/merge_requests/:merge_request_iid/commits' do
+ get ":id/merge_requests/:merge_request_iid/commits" do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
commits = ::Kaminari.paginate_array(merge_request.commits)
present paginate(commits), with: Entities::Commit
end
- desc 'Show the merge request changes' do
+ desc "Show the merge request changes" do
success Entities::MergeRequestChanges
end
- get ':id/merge_requests/:merge_request_iid/changes' do
+ get ":id/merge_requests/:merge_request_iid/changes" do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
present merge_request, with: Entities::MergeRequestChanges, current_user: current_user, project: user_project
end
- desc 'Get the merge request pipelines' do
+ desc "Get the merge request pipelines" do
success Entities::PipelineBasic
end
- get ':id/merge_requests/:merge_request_iid/pipelines' do
+ get ":id/merge_requests/:merge_request_iid/pipelines" do
pipelines = merge_request_pipelines_with_access
present paginate(pipelines), with: Entities::PipelineBasic
end
- desc 'Update a merge request' do
+ 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'
+ 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"
optional :state_event, type: String, values: %w[close reopen],
- desc: 'Status of the merge request'
- optional :discussion_locked, type: Boolean, desc: 'Whether the MR discussion is locked'
+ desc: "Status of the merge request"
+ optional :discussion_locked, type: Boolean, desc: "Whether the MR discussion is locked"
use :optional_params
at_least_one_of(*::API::MergeRequests.update_params_at_least_one_of)
end
- put ':id/merge_requests/:merge_request_iid' do
- Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42318')
+ put ":id/merge_requests/:merge_request_iid" do
+ Gitlab::QueryLimiting.whitelist("https://gitlab.com/gitlab-org/gitlab-ce/issues/42318")
merge_request = find_merge_request_with_access(params.delete(:merge_request_iid), :update_merge_request)
@@ -338,21 +338,21 @@ module API
end
end
- desc 'Merge a merge request' do
+ desc "Merge a merge request" do
success Entities::MergeRequest
end
params do
- optional :merge_commit_message, type: String, desc: 'Custom merge commit message'
- optional :squash_commit_message, type: String, desc: 'Custom squash commit message'
+ optional :merge_commit_message, type: String, desc: "Custom merge commit message"
+ optional :squash_commit_message, type: String, desc: "Custom squash commit message"
optional :should_remove_source_branch, type: Boolean,
- desc: 'When true, the source branch will be deleted if possible'
+ desc: "When true, the source branch will be deleted if possible"
optional :merge_when_pipeline_succeeds, type: Boolean,
- desc: 'When true, this merge request will be merged when the pipeline succeeds'
- optional :sha, type: String, desc: 'When present, must have the HEAD SHA of the source branch'
- optional :squash, type: Grape::API::Boolean, desc: 'When true, the commits will be squashed into a single commit on merge'
+ desc: "When true, this merge request will be merged when the pipeline succeeds"
+ optional :sha, type: String, desc: "When present, must have the HEAD SHA of the source branch"
+ optional :squash, type: Grape::API::Boolean, desc: "When true, the commits will be squashed into a single commit on merge"
end
- put ':id/merge_requests/:merge_request_iid/merge' do
- Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42317')
+ put ":id/merge_requests/:merge_request_iid/merge" do
+ Gitlab::QueryLimiting.whitelist("https://gitlab.com/gitlab-org/gitlab-ce/issues/42317")
merge_request = find_project_merge_request(params[:merge_request_iid])
merge_when_pipeline_succeeds = to_boolean(params[:merge_when_pipeline_succeeds])
@@ -363,7 +363,7 @@ module API
not_allowed! unless merge_request.mergeable_state?(skip_ci_check: merge_when_pipeline_succeeds)
- render_api_error!('Branch cannot be merged', 406) unless merge_request.mergeable?(skip_ci_check: merge_when_pipeline_succeeds)
+ render_api_error!("Branch cannot be merged", 406) unless merge_request.mergeable?(skip_ci_check: merge_when_pipeline_succeeds)
check_sha_param!(params, merge_request)
@@ -388,17 +388,17 @@ module API
present merge_request, with: Entities::MergeRequest, current_user: current_user, project: user_project
end
- desc 'Merge a merge request to its default temporary merge ref path'
+ desc "Merge a merge request to its default temporary merge ref path"
params do
- optional :merge_commit_message, type: String, desc: 'Custom merge commit message'
+ optional :merge_commit_message, type: String, desc: "Custom merge commit message"
end
- put ':id/merge_requests/:merge_request_iid/merge_to_ref' do
+ put ":id/merge_requests/:merge_request_iid/merge_to_ref" do
merge_request = find_project_merge_request(params[:merge_request_iid])
authorize! :admin_merge_request, user_project
merge_params = {
- commit_message: params[:merge_commit_message]
+ commit_message: params[:merge_commit_message],
}
result = ::MergeRequests::MergeToRefService
@@ -416,7 +416,7 @@ module API
desc 'Cancel merge if "Merge When Pipeline Succeeds" is enabled' do
success Entities::MergeRequest
end
- post ':id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds' do
+ post ":id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds" do
merge_request = find_project_merge_request(params[:merge_request_iid])
unauthorized! unless merge_request.can_cancel_merge_when_pipeline_succeeds?(current_user)
@@ -426,10 +426,10 @@ module API
.cancel(merge_request)
end
- desc 'Rebase the merge request against its target branch' do
- detail 'This feature was added in GitLab 11.6'
+ desc "Rebase the merge request against its target branch" do
+ detail "This feature was added in GitLab 11.6"
end
- put ':id/merge_requests/:merge_request_iid/rebase' do
+ put ":id/merge_requests/:merge_request_iid/rebase" do
merge_request = find_project_merge_request(params[:merge_request_iid])
authorize_push_to_merge_request!(merge_request)
@@ -439,13 +439,13 @@ module API
status :accepted
end
- desc 'List issues that will be closed on merge' do
+ desc "List issues that will be closed on merge" do
success Entities::MRNote
end
params do
use :pagination
end
- get ':id/merge_requests/:merge_request_iid/closes_issues' do
+ get ":id/merge_requests/:merge_request_iid/closes_issues" do
merge_request = find_merge_request_with_access(params[:merge_request_iid])
issues = ::Kaminari.paginate_array(merge_request.visible_closing_issues_for(current_user))
issues = paginate(issues)
View Lorry Controller Status