2013-05-14 12:33:31 +00:00
|
|
|
module API
|
2012-07-24 12:19:51 +00:00
|
|
|
class Issues < Grape::API
|
2016-11-07 14:15:14 +00:00
|
|
|
include PaginationParams
|
|
|
|
|
2012-07-24 12:19:51 +00:00
|
|
|
before { authenticate! }
|
|
|
|
|
2014-08-14 10:41:16 +00:00
|
|
|
helpers do
|
2017-01-04 08:23:46 +00:00
|
|
|
# TODO: Remove in 9.0 and switch to IssueFinder-based label filtering
|
2014-08-14 14:17:19 +00:00
|
|
|
def filter_issues_labels(issues, labels)
|
2014-09-04 22:01:12 +00:00
|
|
|
issues.includes(:labels).where('labels.title' => labels.split(','))
|
|
|
|
end
|
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
params :issues_params do
|
|
|
|
optional :labels, type: String, desc: 'Comma-separated list of label names'
|
|
|
|
optional :order_by, type: String, values: %w[created_at updated_at], default: 'created_at',
|
|
|
|
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.'
|
2017-01-04 09:07:00 +00:00
|
|
|
optional :milestone, type: String, desc: 'Return issues for a specific milestone'
|
2016-11-07 14:15:14 +00:00
|
|
|
use :pagination
|
|
|
|
end
|
2016-11-10 10:23:44 +00:00
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
params :issue_params do
|
|
|
|
optional :description, type: String, desc: 'The description of an issue'
|
|
|
|
optional :assignee_id, type: Integer, desc: 'The ID of a user to assign issue'
|
|
|
|
optional :milestone_id, type: Integer, desc: 'The ID of a milestone to assign issue'
|
|
|
|
optional :labels, type: String, desc: 'Comma-separated list of label names'
|
|
|
|
optional :due_date, type: String, desc: 'Date time string in the format YEAR-MONTH-DAY'
|
|
|
|
optional :confidential, type: Boolean, desc: 'Boolean parameter if the issue should be confidential'
|
2016-11-10 10:23:44 +00:00
|
|
|
end
|
2014-08-14 10:41:16 +00:00
|
|
|
end
|
|
|
|
|
2012-07-24 12:19:51 +00:00
|
|
|
resource :issues do
|
2016-11-07 14:15:14 +00:00
|
|
|
desc "Get currently authenticated user's issues" do
|
|
|
|
success Entities::Issue
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
optional :state, type: String, values: %w[opened closed all], default: 'all',
|
|
|
|
desc: 'Return opened, closed, or all issues'
|
|
|
|
use :issues_params
|
|
|
|
end
|
2012-07-24 12:19:51 +00:00
|
|
|
get do
|
2017-01-04 08:23:46 +00:00
|
|
|
issues = IssuesFinder.new(current_user, scope: 'all', author_id: current_user.id, state: params[:state]).execute.inc_notes_with_associations
|
2014-08-14 14:17:19 +00:00
|
|
|
issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].nil?
|
2016-11-07 14:15:14 +00:00
|
|
|
issues = issues.reorder(params[:order_by] => params[:sort])
|
2016-09-09 14:16:14 +00:00
|
|
|
|
2016-04-08 06:41:10 +00:00
|
|
|
present paginate(issues), with: Entities::Issue, current_user: current_user
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
params do
|
|
|
|
requires :id, type: String, desc: 'The ID of a group'
|
|
|
|
end
|
2016-06-07 22:01:54 +00:00
|
|
|
resource :groups do
|
2016-11-07 14:15:14 +00:00
|
|
|
desc 'Get a list of group issues' do
|
|
|
|
success Entities::Issue
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
optional :state, type: String, values: %w[opened closed all], default: 'opened',
|
|
|
|
desc: 'Return opened, closed, or all issues'
|
|
|
|
use :issues_params
|
|
|
|
end
|
2016-06-07 22:01:54 +00:00
|
|
|
get ":id/issues" do
|
2016-11-07 14:15:14 +00:00
|
|
|
group = find_group!(params.delete(:id))
|
2016-06-07 22:01:54 +00:00
|
|
|
|
|
|
|
params[:group_id] = group.id
|
|
|
|
params[:milestone_title] = params.delete(:milestone)
|
|
|
|
params[:label_name] = params.delete(:labels)
|
2016-09-09 14:16:14 +00:00
|
|
|
|
2016-06-07 22:01:54 +00:00
|
|
|
issues = IssuesFinder.new(current_user, params).execute
|
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
issues = issues.reorder(params[:order_by] => params[:sort])
|
2016-06-07 22:01:54 +00:00
|
|
|
present paginate(issues), with: Entities::Issue, current_user: current_user
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-11-10 10:23:44 +00:00
|
|
|
params do
|
|
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
|
|
end
|
2012-07-24 12:19:51 +00:00
|
|
|
resource :projects do
|
2016-11-07 14:15:14 +00:00
|
|
|
desc 'Get a list of project issues' do
|
|
|
|
success Entities::Issue
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
optional :state, type: String, values: %w[opened closed all], default: 'all',
|
|
|
|
desc: 'Return opened, closed, or all issues'
|
|
|
|
optional :iid, type: Integer, desc: 'The IID of the issue'
|
|
|
|
use :issues_params
|
|
|
|
end
|
2012-07-24 12:19:51 +00:00
|
|
|
get ":id/issues" do
|
2017-01-04 08:23:46 +00:00
|
|
|
issues = IssuesFinder.new(current_user,
|
|
|
|
project_id: user_project.id,
|
|
|
|
state: params[:state],
|
|
|
|
milestone_title: params[:milestone]).execute.inc_notes_with_associations
|
2014-08-14 14:17:19 +00:00
|
|
|
issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].nil?
|
2015-01-17 22:45:39 +00:00
|
|
|
issues = filter_by_iid(issues, params[:iid]) unless params[:iid].nil?
|
2016-11-07 14:15:14 +00:00
|
|
|
issues = issues.reorder(params[:order_by] => params[:sort])
|
2017-01-04 08:23:46 +00:00
|
|
|
|
2016-11-04 18:19:08 +00:00
|
|
|
present paginate(issues), with: Entities::Issue, current_user: current_user, project: user_project
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
desc 'Get a single project issue' do
|
|
|
|
success Entities::Issue
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :issue_id, type: Integer, desc: 'The ID of a project issue'
|
|
|
|
end
|
2012-07-24 12:19:51 +00:00
|
|
|
get ":id/issues/:issue_id" do
|
2016-11-07 14:15:14 +00:00
|
|
|
issue = find_project_issue(params[:issue_id])
|
|
|
|
present issue, with: Entities::Issue, current_user: current_user, project: user_project
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
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_for_resolving_discussions, type: Integer,
|
|
|
|
desc: 'The IID of a merge request for which to resolve discussions'
|
|
|
|
use :issue_params
|
|
|
|
end
|
2016-07-12 15:59:21 +00:00
|
|
|
post ':id/issues' do
|
2016-11-07 14:15:14 +00:00
|
|
|
# Setting created_at time only allowed for admins and project owners
|
|
|
|
unless current_user.admin? || user_project.owner == current_user
|
|
|
|
params.delete(:created_at)
|
|
|
|
end
|
2014-07-30 14:17:29 +00:00
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
issue_params = declared_params(include_missing: false)
|
2016-12-06 16:13:14 +00:00
|
|
|
|
|
|
|
if merge_request_iid = params[:merge_request_for_resolving_discussions]
|
2016-11-07 14:15:14 +00:00
|
|
|
issue_params[:merge_request_for_resolving_discussions] = MergeRequestsFinder.new(current_user, project_id: user_project.id).
|
2016-12-06 16:13:14 +00:00
|
|
|
execute.
|
|
|
|
find_by(iid: merge_request_iid)
|
|
|
|
end
|
2016-10-26 21:21:50 +00:00
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
issue = ::Issues::CreateService.new(user_project,
|
|
|
|
current_user,
|
|
|
|
issue_params.merge(request: request, api: true)).execute
|
2016-07-30 04:18:32 +00:00
|
|
|
if issue.spam?
|
2016-07-21 23:11:53 +00:00
|
|
|
render_api_error!({ error: 'Spam detected' }, 400)
|
|
|
|
end
|
2016-07-18 23:17:43 +00:00
|
|
|
|
2014-04-02 10:38:35 +00:00
|
|
|
if issue.valid?
|
2016-11-04 18:19:08 +00:00
|
|
|
present issue, with: Entities::Issue, current_user: current_user, project: user_project
|
2014-04-02 10:38:35 +00:00
|
|
|
else
|
2014-08-18 18:09:09 +00:00
|
|
|
render_validation_error!(issue)
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-11-10 10:23:44 +00:00
|
|
|
desc 'Update an existing issue' do
|
|
|
|
success Entities::Issue
|
|
|
|
end
|
|
|
|
params do
|
2016-11-07 14:15:14 +00:00
|
|
|
requires :issue_id, type: Integer, desc: 'The ID of a project issue'
|
|
|
|
optional :title, type: String, desc: 'The title of an issue'
|
|
|
|
optional :updated_at, type: DateTime,
|
|
|
|
desc: 'Date time when the issue was updated. Available only for admins and project owners.'
|
2016-12-22 08:41:53 +00:00
|
|
|
optional :state_event, type: String, values: %w[reopen close], desc: 'State of the issue'
|
2016-11-07 14:15:14 +00:00
|
|
|
use :issue_params
|
|
|
|
at_least_one_of :title, :description, :assignee_id, :milestone_id,
|
|
|
|
:labels, :created_at, :due_date, :confidential, :state_event
|
2016-11-10 10:23:44 +00:00
|
|
|
end
|
2016-07-12 15:59:21 +00:00
|
|
|
put ':id/issues/:issue_id' do
|
2016-11-07 14:15:14 +00:00
|
|
|
issue = user_project.issues.find(params.delete(:issue_id))
|
2015-06-26 13:55:56 +00:00
|
|
|
authorize! :update_issue, issue
|
2016-08-15 16:50:41 +00:00
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
# Setting created_at time only allowed for admins and project owners
|
|
|
|
unless current_user.admin? || user_project.owner == current_user
|
|
|
|
params.delete(:updated_at)
|
|
|
|
end
|
2016-07-15 14:21:53 +00:00
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
issue = ::Issues::UpdateService.new(user_project,
|
|
|
|
current_user,
|
|
|
|
declared_params(include_missing: false)).execute(issue)
|
2013-06-11 15:15:18 +00:00
|
|
|
|
2014-04-02 10:54:41 +00:00
|
|
|
if issue.valid?
|
2016-11-04 18:19:08 +00:00
|
|
|
present issue, with: Entities::Issue, current_user: current_user, project: user_project
|
2014-04-02 10:54:41 +00:00
|
|
|
else
|
2014-08-18 18:09:09 +00:00
|
|
|
render_validation_error!(issue)
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
desc 'Move an existing issue' do
|
|
|
|
success Entities::Issue
|
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :issue_id, type: Integer, desc: 'The ID of a project issue'
|
|
|
|
requires :to_project_id, type: Integer, desc: 'The ID of the new project'
|
|
|
|
end
|
2016-04-12 16:38:18 +00:00
|
|
|
post ':id/issues/:issue_id/move' do
|
2016-11-07 14:15:14 +00:00
|
|
|
issue = user_project.issues.find_by(id: params[:issue_id])
|
|
|
|
not_found!('Issue') unless issue
|
2016-04-07 12:07:17 +00:00
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
new_project = Project.find_by(id: params[:to_project_id])
|
|
|
|
not_found!('Project') unless new_project
|
2016-04-07 12:07:17 +00:00
|
|
|
|
|
|
|
begin
|
|
|
|
issue = ::Issues::MoveService.new(user_project, current_user).execute(issue, new_project)
|
2016-11-04 18:19:08 +00:00
|
|
|
present issue, with: Entities::Issue, current_user: current_user, project: user_project
|
2016-04-07 12:07:17 +00:00
|
|
|
rescue ::Issues::MoveService::MoveError => error
|
|
|
|
render_api_error!(error.message, 400)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-11-07 14:15:14 +00:00
|
|
|
desc 'Delete a project issue'
|
|
|
|
params do
|
|
|
|
requires :issue_id, type: Integer, desc: 'The ID of a project issue'
|
|
|
|
end
|
2012-07-24 12:19:51 +00:00
|
|
|
delete ":id/issues/:issue_id" do
|
2016-03-21 13:12:52 +00:00
|
|
|
issue = user_project.issues.find_by(id: params[:issue_id])
|
2016-11-07 14:15:14 +00:00
|
|
|
not_found!('Issue') unless issue
|
2016-02-26 08:55:43 +00:00
|
|
|
|
2016-03-21 13:12:52 +00:00
|
|
|
authorize!(:destroy_issue, issue)
|
2016-02-26 08:55:43 +00:00
|
|
|
issue.destroy
|
2012-07-24 12:19:51 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|