debian-mirror-gitlab/lib/api/issues.rb

424 lines
18 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
module API
2020-07-28 23:09:34 +05:30
class Issues < Grape::API::Instance
2017-08-17 22:00:37 +05:30
include PaginationParams
2019-09-04 21:01:54 +05:30
helpers Helpers::IssuesHelpers
2020-04-22 19:07:51 +05:30
helpers Helpers::RateLimiter
2017-08-17 22:00:37 +05:30
2018-11-08 19:23:39 +05:30
before { authenticate_non_get! }
2014-09-02 18:07:02 +05:30
2015-04-26 12:48:37 +05:30
helpers do
2019-12-04 20:38:33 +05:30
params :negatable_issue_filter_params do
2020-07-28 23:09:34 +05:30
optional :labels, type: Array[String], coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, desc: 'Comma-separated list of label names'
2017-08-17 22:00:37 +05:30
optional :milestone, type: String, desc: 'Milestone title'
2020-07-28 23:09:34 +05:30
optional :iids, type: Array[Integer], coerce_with: ::API::Validations::Types::CommaSeparatedToIntegerArray.coerce, desc: 'The IID array of issues'
2019-03-02 22:35:43 +05:30
optional :search, type: String, desc: 'Search issues 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'
2019-09-04 21:01:54 +05:30
2017-09-10 17:25:29 +05:30
optional :author_id, type: Integer, desc: 'Return issues which are authored by the user with the given ID'
2019-09-04 21:01:54 +05:30
optional :author_username, type: String, desc: 'Return issues which are authored by the user with the given username'
mutually_exclusive :author_id, :author_username
2018-12-13 13:39:08 +05:30
optional :assignee_id, types: [Integer, String], integer_none_any: true,
2019-12-04 20:38:33 +05:30
desc: 'Return issues which are assigned to the user with the given ID'
2019-09-04 21:01:54 +05:30
optional :assignee_username, type: Array[String], check_assignees_count: true,
2020-04-22 19:07:51 +05:30
coerce_with: Validations::Validators::CheckAssigneesCount.coerce,
2019-12-04 20:38:33 +05:30
desc: 'Return issues which are assigned to the user with the given username'
2019-09-04 21:01:54 +05:30
mutually_exclusive :assignee_id, :assignee_username
2019-12-04 20:38:33 +05:30
end
params :issues_stats_params do
use :negatable_issue_filter_params
optional :created_after, type: DateTime, desc: 'Return issues created after the specified time'
optional :created_before, type: DateTime, desc: 'Return issues created before the specified time'
optional :updated_after, type: DateTime, desc: 'Return issues updated after the specified time'
optional :updated_before, type: DateTime, desc: 'Return issues updated before the specified time'
optional :not, type: Hash do
use :negatable_issue_filter_params
end
2019-09-04 21:01:54 +05:30
2018-11-08 19:23:39 +05:30
optional :scope, type: String, values: %w[created-by-me assigned-to-me created_by_me assigned_to_me all],
desc: 'Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`'
2018-03-17 18:26:18 +05:30
optional :my_reaction_emoji, type: String, desc: 'Return issues reacted by the authenticated user by the given emoji'
2019-07-07 11:18:12 +05:30
optional :confidential, type: Boolean, desc: 'Filter confidential or public issues'
2018-12-13 13:39:08 +05:30
2019-09-04 21:01:54 +05:30
use :optional_issues_params_ee
end
params :issues_params do
2020-03-13 15:44:24 +05:30
optional :with_labels_details, type: Boolean, desc: 'Return titles of labels and other details', default: false
2019-09-04 21:01:54 +05:30
optional :state, type: String, values: %w[opened closed all], default: 'all',
desc: 'Return opened, closed, or all issues'
2019-12-04 20:38:33 +05:30
optional :order_by, type: String, values: Helpers::IssuesHelpers.sort_options, default: 'created_at',
2019-09-04 21:01:54 +05:30
desc: 'Return issues ordered by `created_at` or `updated_at` fields.'
optional :sort, type: String, values: %w[asc desc], default: 'desc',
desc: 'Return issues sorted in `asc` or `desc` order.'
use :issues_stats_params
use :pagination
2015-04-26 12:48:37 +05:30
end
2017-01-15 13:20:01 +05:30
2018-12-13 13:39:08 +05:30
params :issue_params do
2017-08-17 22:00:37 +05:30
optional :description, type: String, desc: 'The description of an issue'
2020-07-28 23:09:34 +05:30
optional :assignee_ids, type: Array[Integer], coerce_with: ::API::Validations::Types::CommaSeparatedToIntegerArray.coerce, desc: 'The array of user IDs to assign issue'
2017-08-17 22:00:37 +05:30
optional :assignee_id, type: Integer, desc: '[Deprecated] The ID of a user to assign issue'
optional :milestone_id, type: Integer, desc: 'The ID of a milestone to assign issue'
2020-07-28 23:09:34 +05:30
optional :labels, type: Array[String], coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, desc: 'Comma-separated list of label names'
optional :add_labels, type: Array[String], coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, desc: 'Comma-separated list of label names'
optional :remove_labels, type: Array[String], coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, desc: 'Comma-separated list of label names'
2017-08-17 22:00:37 +05:30
optional :due_date, type: String, desc: 'Date string in the format YEAR-MONTH-DAY'
optional :confidential, type: Boolean, desc: 'Boolean parameter if the issue should be confidential'
2018-03-17 18:26:18 +05:30
optional :discussion_locked, type: Boolean, desc: " Boolean parameter indicating if the issue's discussion is locked"
2017-01-15 13:20:01 +05:30
2019-09-04 21:01:54 +05:30
use :optional_issue_params_ee
2017-01-15 13:20:01 +05:30
end
2015-04-26 12:48:37 +05:30
end
2019-09-04 21:01:54 +05:30
desc "Get currently authenticated user's issues statistics"
params do
use :issues_stats_params
optional :scope, type: String, values: %w[created_by_me assigned_to_me all], default: 'created_by_me',
desc: 'Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`'
end
get '/issues_statistics' do
authenticate! unless params[:scope] == 'all'
present issues_statistics, with: Grape::Presenters::Presenter
end
2014-09-02 18:07:02 +05:30
resource :issues do
2017-08-17 22:00:37 +05:30
desc "Get currently authenticated user's issues" do
2019-09-04 21:01:54 +05:30
success Entities::Issue
2017-08-17 22:00:37 +05:30
end
params do
use :issues_params
2018-11-08 19:23:39 +05:30
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 issues for the given scope: `created_by_me`, `assigned_to_me` or `all`'
2020-05-24 23:13:21 +05:30
optional :non_archived, type: Boolean, default: true,
desc: 'Return issues from non archived projects'
2017-08-17 22:00:37 +05:30
end
2014-09-02 18:07:02 +05:30
get do
2018-11-08 19:23:39 +05:30
authenticate! unless params[:scope] == 'all'
2018-03-17 18:26:18 +05:30
issues = paginate(find_issues)
options = {
2019-09-04 21:01:54 +05:30
with: Entities::Issue,
with_labels_details: declared_params[:with_labels_details],
2018-03-17 18:26:18 +05:30
current_user: current_user,
2019-10-12 21:52:04 +05:30
include_subscribed: false
2018-03-17 18:26:18 +05:30
}
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
present issues, options
2014-09-02 18:07:02 +05:30
end
end
2017-08-17 22:00:37 +05:30
params do
requires :id, type: String, desc: 'The ID of a group'
end
2019-02-15 15:39:39 +05:30
resource :groups, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-08-17 22:00:37 +05:30
desc 'Get a list of group issues' do
2019-09-04 21:01:54 +05:30
success Entities::Issue
2017-08-17 22:00:37 +05:30
end
params do
use :issues_params
2020-03-13 15:44:24 +05:30
optional :non_archived, type: Boolean, desc: 'Return issues from non archived projects', default: true
2017-08-17 22:00:37 +05:30
end
2016-08-24 12:49:21 +05:30
get ":id/issues" do
2020-03-13 15:44:24 +05:30
issues = paginate(find_issues(group_id: user_group.id, include_subgroups: true))
2018-03-17 18:26:18 +05:30
options = {
2019-09-04 21:01:54 +05:30
with: Entities::Issue,
with_labels_details: declared_params[:with_labels_details],
2018-03-17 18:26:18 +05:30
current_user: current_user,
2020-03-13 15:44:24 +05:30
include_subscribed: false,
group: user_group
2018-03-17 18:26:18 +05:30
}
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
present issues, options
2016-08-24 12:49:21 +05:30
end
2019-09-04 21:01:54 +05:30
desc 'Get statistics for the list of group issues'
params do
use :issues_stats_params
end
get ":id/issues_statistics" do
2020-03-13 15:44:24 +05:30
present issues_statistics(group_id: user_group.id, include_subgroups: true), with: Grape::Presenters::Presenter
2019-09-04 21:01:54 +05:30
end
2016-08-24 12:49:21 +05:30
end
2017-01-15 13:20:01 +05:30
params do
requires :id, type: String, desc: 'The ID of a project'
end
2019-02-15 15:39:39 +05:30
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2017-08-17 22:00:37 +05:30
include TimeTrackingEndpoints
2017-01-15 13:20:01 +05:30
2017-08-17 22:00:37 +05:30
desc 'Get a list of project issues' do
2019-09-04 21:01:54 +05:30
success Entities::Issue
2017-08-17 22:00:37 +05:30
end
params do
use :issues_params
end
2014-09-02 18:07:02 +05:30
get ":id/issues" do
2020-03-13 15:44:24 +05:30
issues = paginate(find_issues(project_id: user_project.id))
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
options = {
2019-09-04 21:01:54 +05:30
with: Entities::Issue,
with_labels_details: declared_params[:with_labels_details],
2018-03-17 18:26:18 +05:30
current_user: current_user,
project: user_project,
2019-10-12 21:52:04 +05:30
include_subscribed: false
2018-03-17 18:26:18 +05:30
}
present issues, options
2014-09-02 18:07:02 +05:30
end
2019-09-04 21:01:54 +05:30
desc 'Get statistics for the list of project issues'
params do
use :issues_stats_params
end
get ":id/issues_statistics" do
2020-03-13 15:44:24 +05:30
present issues_statistics(project_id: user_project.id), with: Grape::Presenters::Presenter
2019-09-04 21:01:54 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Get a single project issue' do
success Entities::Issue
end
params do
requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
end
2017-09-10 17:25:29 +05:30
get ":id/issues/:issue_iid", as: :api_v4_project_issue do
2017-08-17 22:00:37 +05:30
issue = find_project_issue(params[:issue_iid])
present issue, with: Entities::Issue, current_user: current_user, project: user_project
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Create a new project issue' do
success Entities::Issue
end
params do
requires :title, type: String, desc: 'The title of an issue'
optional :created_at, type: DateTime,
desc: 'Date time when the issue was created. Available only for admins and project owners.'
optional :merge_request_to_resolve_discussions_of, type: Integer,
desc: 'The IID of a merge request for which to resolve discussions'
optional :discussion_to_resolve, type: String,
desc: 'The ID of a discussion to resolve, also pass `merge_request_to_resolve_discussions_of`'
2018-11-18 11:00:15 +05:30
optional :iid, type: Integer,
desc: 'The internal ID of a project issue. Available only for admins and project owners.'
2017-08-17 22:00:37 +05:30
use :issue_params
end
2016-08-24 12:49:21 +05:30
post ':id/issues' do
2019-12-04 20:38:33 +05:30
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-foss/issues/42320')
2018-03-17 18:26:18 +05:30
2020-04-22 19:07:51 +05:30
check_rate_limit! :issues_create, [current_user, :issues_create]
2018-03-17 18:26:18 +05:30
authorize! :create_issue, user_project
2018-11-20 20:47:30 +05:30
params.delete(:created_at) unless current_user.can?(:set_issue_created_at, user_project)
params.delete(:iid) unless current_user.can?(:set_issue_iid, user_project)
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
issue_params = declared_params(include_missing: false)
2019-07-31 22:56:46 +05:30
issue_params[:system_note_timestamp] = params[:created_at]
2016-04-02 18:10:28 +05:30
2017-08-17 22:00:37 +05:30
issue_params = convert_parameters_from_legacy_format(issue_params)
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
begin
issue = ::Issues::CreateService.new(user_project,
current_user,
issue_params.merge(request: request, api: true)).execute
if issue.spam?
render_api_error!({ error: 'Spam detected' }, 400)
end
if issue.valid?
present issue, with: Entities::Issue, current_user: current_user, project: user_project
else
render_validation_error!(issue)
end
rescue ::ActiveRecord::RecordNotUnique
render_api_error!('Duplicated issue', 409)
2014-09-02 18:07:02 +05:30
end
end
2017-01-15 13:20:01 +05:30
desc 'Update an existing issue' do
success Entities::Issue
end
params do
2017-08-17 22:00:37 +05:30
requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
optional :title, type: String, desc: 'The title of an issue'
optional :updated_at, type: DateTime,
2020-04-08 14:13:33 +05:30
allow_blank: false,
2017-08-17 22:00:37 +05:30
desc: 'Date time when the issue was updated. Available only for admins and project owners.'
optional :state_event, type: String, values: %w[reopen close], desc: 'State of the issue'
use :issue_params
2019-07-07 11:18:12 +05:30
at_least_one_of(*Helpers::IssuesHelpers.update_params_at_least_one_of)
2017-01-15 13:20:01 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
put ':id/issues/:issue_iid' do
2019-12-04 20:38:33 +05:30
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-foss/issues/42322')
2018-03-17 18:26:18 +05:30
2017-08-17 22:00:37 +05:30
issue = user_project.issues.find_by!(iid: params.delete(:issue_iid))
2015-09-11 14:41:01 +05:30
authorize! :update_issue, issue
2016-09-29 09:46:39 +05:30
2019-09-04 21:01:54 +05:30
# Setting updated_at is allowed only for admins and owners
params.delete(:updated_at) unless current_user.can?(:set_issue_updated_at, user_project)
issue.system_note_timestamp = params[:updated_at]
2017-08-17 22:00:37 +05:30
update_params = declared_params(include_missing: false).merge(request: request, api: true)
update_params = convert_parameters_from_legacy_format(update_params)
2017-01-15 13:20:01 +05:30
2017-08-17 22:00:37 +05:30
issue = ::Issues::UpdateService.new(user_project,
current_user,
update_params).execute(issue)
2016-09-29 09:46:39 +05:30
2017-08-17 22:00:37 +05:30
render_spam_error! if issue.spam?
2014-09-02 18:07:02 +05:30
if issue.valid?
2017-08-17 22:00:37 +05:30
present issue, with: Entities::Issue, current_user: current_user, project: user_project
2014-09-02 18:07:02 +05:30
else
2015-04-26 12:48:37 +05:30
render_validation_error!(issue)
2014-09-02 18:07:02 +05:30
end
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2014-09-02 18:07:02 +05:30
2020-07-28 23:09:34 +05:30
desc 'Reorder an existing issue' do
success Entities::Issue
end
params do
requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
optional :move_after_id, type: Integer, desc: 'The ID of the issue we want to be after'
optional :move_before_id, type: Integer, desc: 'The ID of the issue we want to be before'
at_least_one_of :move_after_id, :move_before_id
end
# rubocop: disable CodeReuse/ActiveRecord
put ':id/issues/:issue_iid/reorder' do
issue = user_project.issues.find_by(iid: params[:issue_iid])
not_found!('Issue') unless issue
authorize! :update_issue, issue
if ::Issues::ReorderService.new(user_project, current_user, params).execute(issue)
present issue, with: Entities::Issue, current_user: current_user, project: user_project
else
render_api_error!({ error: 'Unprocessable Entity' }, 422)
end
end
# rubocop: enable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
desc 'Move an existing issue' do
success Entities::Issue
end
params do
requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
requires :to_project_id, type: Integer, desc: 'The ID of the new project'
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
post ':id/issues/:issue_iid/move' do
2019-12-04 20:38:33 +05:30
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-foss/issues/42323')
2018-03-17 18:26:18 +05:30
2017-08-17 22:00:37 +05:30
issue = user_project.issues.find_by(iid: params[:issue_iid])
not_found!('Issue') unless issue
2016-06-02 11:05:42 +05:30
2017-08-17 22:00:37 +05:30
new_project = Project.find_by(id: params[:to_project_id])
not_found!('Project') unless new_project
2016-06-02 11:05:42 +05:30
begin
issue = ::Issues::MoveService.new(user_project, current_user).execute(issue, new_project)
2017-08-17 22:00:37 +05:30
present issue, with: Entities::Issue, current_user: current_user, project: user_project
2016-06-02 11:05:42 +05:30
rescue ::Issues::MoveService::MoveError => error
render_api_error!(error.message, 400)
end
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2016-06-02 11:05:42 +05:30
2017-08-17 22:00:37 +05:30
desc 'Delete a project issue'
params do
requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
delete ":id/issues/:issue_iid" do
issue = user_project.issues.find_by(iid: params[:issue_iid])
not_found!('Issue') unless issue
2016-06-02 11:05:42 +05:30
authorize!(:destroy_issue, issue)
2018-03-17 18:26:18 +05:30
destroy_conditionally!(issue) do |issue|
Issuable::DestroyService.new(user_project, current_user).execute(issue)
end
2014-09-02 18:07:02 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
2019-03-02 22:35:43 +05:30
desc 'List merge requests that are related to the issue' do
2018-12-13 13:39:08 +05:30
success Entities::MergeRequestBasic
end
params do
requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
end
get ':id/issues/:issue_iid/related_merge_requests' do
issue = find_project_issue(params[:issue_iid])
2019-07-07 11:18:12 +05:30
merge_requests = ::Issues::ReferencedMergeRequestsService.new(user_project, current_user)
2018-12-13 13:39:08 +05:30
.execute(issue)
2019-07-07 11:18:12 +05:30
.first
2019-05-30 16:15:17 +05:30
2019-07-07 11:18:12 +05:30
present paginate(::Kaminari.paginate_array(merge_requests)),
with: Entities::MergeRequest,
current_user: current_user,
2019-12-21 20:55:43 +05:30
project: user_project,
include_subscribed: false
2018-12-13 13:39:08 +05:30
end
2019-03-02 22:35:43 +05:30
desc 'List merge requests closing issue' do
2017-08-17 22:00:37 +05:30
success Entities::MergeRequestBasic
end
params do
requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
get ':id/issues/:issue_iid/closed_by' do
issue = find_project_issue(params[:issue_iid])
merge_request_ids = MergeRequestsClosingIssues.where(issue_id: issue).select(:merge_request_id)
merge_requests = MergeRequestsFinder.new(current_user, project_id: user_project.id).execute.where(id: merge_request_ids)
present paginate(merge_requests), with: Entities::MergeRequestBasic, current_user: current_user, project: user_project
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2017-09-10 17:25:29 +05:30
2019-03-02 22:35:43 +05:30
desc 'List participants for an issue' do
2018-03-17 18:26:18 +05:30
success Entities::UserBasic
end
params do
requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
end
get ':id/issues/:issue_iid/participants' do
issue = find_project_issue(params[:issue_iid])
participants = ::Kaminari.paginate_array(issue.participants)
present paginate(participants), with: Entities::UserBasic, current_user: current_user, project: user_project
end
2017-09-10 17:25:29 +05:30
desc 'Get the user agent details for an issue' do
success Entities::UserAgentDetail
end
params do
requires :issue_iid, type: Integer, desc: 'The internal ID of a project issue'
end
get ":id/issues/:issue_iid/user_agent_detail" do
authenticated_as_admin!
issue = find_project_issue(params[:issue_iid])
2018-10-15 14:42:47 +05:30
break not_found!('UserAgentDetail') unless issue.user_agent_detail
2017-09-10 17:25:29 +05:30
present issue.user_agent_detail, with: Entities::UserAgentDetail
end
2014-09-02 18:07:02 +05:30
end
end
end