gitlab-org--gitlab-foss/lib/api/issues.rb

265 lines
10 KiB
Ruby
Raw Normal View History

module API
2012-07-24 08:19:51 -04:00
# Issues API
class Issues < Grape::API
before { authenticate! }
2014-08-14 06:41:16 -04:00
helpers do
2014-09-04 18:01:12 -04:00
def filter_issues_state(issues, state)
2014-08-14 06:41:16 -04:00
case state
when 'opened' then issues.opened
when 'closed' then issues.closed
else issues
2014-08-14 06:41:16 -04:00
end
end
2014-08-14 10:17:19 -04:00
def filter_issues_labels(issues, labels)
2014-09-04 18:01:12 -04:00
issues.includes(:labels).where('labels.title' => labels.split(','))
end
def filter_issues_milestone(issues, milestone)
issues.includes(:milestone).where('milestones.title' => milestone)
2014-08-14 10:17:19 -04:00
end
2014-08-14 06:41:16 -04:00
end
2012-07-24 08:19:51 -04:00
resource :issues do
# Get currently authenticated user's issues
#
2014-08-14 06:41:16 -04:00
# Parameters:
# state (optional) - Return "opened" or "closed" issues
2014-08-14 10:17:19 -04:00
# labels (optional) - Comma-separated list of label names
# order_by (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
# sort (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
#
2014-08-14 06:41:16 -04:00
# Example Requests:
2012-07-24 08:19:51 -04:00
# GET /issues
2014-08-14 06:41:16 -04:00
# GET /issues?state=opened
# GET /issues?state=closed
2014-08-14 10:17:19 -04:00
# GET /issues?labels=foo
# GET /issues?labels=foo,bar
# GET /issues?labels=foo,bar&state=opened
2012-07-24 08:19:51 -04:00
get do
issues = current_user.issues.inc_notes_with_associations
2014-08-14 10:17:19 -04:00
issues = filter_issues_state(issues, params[:state]) unless params[:state].nil?
issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].nil?
2016-09-09 10:16:14 -04:00
issues = issues.reorder(issuable_order_by => issuable_sort)
2016-04-08 02:41:10 -04:00
present paginate(issues), with: Entities::Issue, current_user: current_user
2012-07-24 08:19:51 -04:00
end
end
resource :groups do
# Get a list of group issues
#
# Parameters:
# id (required) - The ID of a group
# state (optional) - Return "opened" or "closed" issues
# labels (optional) - Comma-separated list of label names
# milestone (optional) - Milestone title
# order_by (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
# sort (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
#
# Example Requests:
# GET /groups/:id/issues
# GET /groups/:id/issues?state=opened
# GET /groups/:id/issues?state=closed
# GET /groups/:id/issues?labels=foo
# GET /groups/:id/issues?labels=foo,bar
# GET /groups/:id/issues?labels=foo,bar&state=opened
# GET /groups/:id/issues?milestone=1.0.0
# GET /groups/:id/issues?milestone=1.0.0&state=closed
get ":id/issues" do
group = find_group(params[:id])
params[:state] ||= 'opened'
params[:group_id] = group.id
params[:milestone_title] = params.delete(:milestone)
params[:label_name] = params.delete(:labels)
2016-09-09 10:16:14 -04:00
if params[:order_by] || params[:sort]
# The Sortable concern takes 'created_desc', not 'created_at_desc' (for example)
params[:sort] = "#{issuable_order_by.sub('_at', '')}_#{issuable_sort}"
end
issues = IssuesFinder.new(current_user, params).execute
present paginate(issues), with: Entities::Issue, current_user: current_user
end
end
2012-07-24 08:19:51 -04:00
resource :projects do
# Get a list of project issues
#
# Parameters:
# id (required) - The ID of a project
# iid (optional) - Return the project issue having the given `iid`
2014-08-14 06:41:16 -04:00
# state (optional) - Return "opened" or "closed" issues
2014-08-14 10:17:19 -04:00
# labels (optional) - Comma-separated list of label names
2014-09-04 18:01:12 -04:00
# milestone (optional) - Milestone title
# order_by (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
# sort (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
2014-08-14 06:41:16 -04:00
#
# Example Requests:
2012-07-24 08:19:51 -04:00
# GET /projects/:id/issues
2014-08-14 06:41:16 -04:00
# GET /projects/:id/issues?state=opened
# GET /projects/:id/issues?state=closed
2014-08-14 10:17:19 -04:00
# GET /projects/:id/issues?labels=foo
# GET /projects/:id/issues?labels=foo,bar
# GET /projects/:id/issues?labels=foo,bar&state=opened
2014-09-04 18:01:12 -04:00
# GET /projects/:id/issues?milestone=1.0.0
# GET /projects/:id/issues?milestone=1.0.0&state=closed
# GET /issues?iid=42
2012-07-24 08:19:51 -04:00
get ":id/issues" do
issues = user_project.issues.inc_notes_with_associations.visible_to_user(current_user)
2014-08-14 10:17:19 -04:00
issues = filter_issues_state(issues, params[:state]) unless params[:state].nil?
issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].nil?
issues = filter_by_iid(issues, params[:iid]) unless params[:iid].nil?
2014-09-04 18:01:12 -04:00
unless params[:milestone].nil?
issues = filter_issues_milestone(issues, params[:milestone])
end
2014-08-14 10:17:19 -04:00
2016-09-09 10:16:14 -04:00
issues = issues.reorder(issuable_order_by => issuable_sort)
2016-04-08 02:41:10 -04:00
present paginate(issues), with: Entities::Issue, current_user: current_user
2012-07-24 08:19:51 -04:00
end
# Get a single project issue
#
# Parameters:
# id (required) - The ID of a project
2012-07-24 08:19:51 -04:00
# issue_id (required) - The ID of a project issue
# Example Request:
# GET /projects/:id/issues/:issue_id
get ":id/issues/:issue_id" do
@issue = find_project_issue(params[:issue_id])
2016-04-08 02:41:10 -04:00
present @issue, with: Entities::Issue, current_user: current_user
2012-07-24 08:19:51 -04:00
end
# Create a new project issue
#
# Parameters:
# id (required) - The ID of a project
# title (required) - The title of an issue
# description (optional) - The description of an issue
# assignee_id (optional) - The ID of a user to assign issue
2012-07-24 08:19:51 -04:00
# milestone_id (optional) - The ID of a milestone to assign issue
# labels (optional) - The labels of an issue
2016-04-05 13:05:55 -04:00
# created_at (optional) - Date time string, ISO 8601 formatted
2016-07-12 11:59:21 -04:00
# due_date (optional) - Date time string in the format YEAR-MONTH-DAY
2016-07-15 10:21:53 -04:00
# confidential (optional) - Boolean parameter if the issue should be confidential
2012-07-24 08:19:51 -04:00
# Example Request:
# POST /projects/:id/issues
2016-07-12 11:59:21 -04:00
post ':id/issues' do
required_attributes! [:title]
2016-07-15 10:21:53 -04:00
keys = [:title, :description, :assignee_id, :milestone_id, :due_date, :confidential]
keys << :created_at if current_user.admin? || user_project.owner == current_user
attrs = attributes_for_keys(keys)
# Validate label names in advance
if (errors = validate_label_params(params)).any?
render_api_error!({ labels: errors }, 400)
end
attrs[:labels] = params[:labels] if params[:labels]
2016-07-15 10:21:53 -04:00
# Convert and filter out invalid confidential flags
attrs['confidential'] = to_boolean(attrs['confidential'])
attrs.delete('confidential') if attrs['confidential'].nil?
issue = ::Issues::CreateService.new(user_project, current_user, attrs.merge(request: request, api: true)).execute
if issue.spam?
render_api_error!({ error: 'Spam detected' }, 400)
end
if issue.valid?
2016-04-08 02:41:10 -04:00
present issue, with: Entities::Issue, current_user: current_user
else
render_validation_error!(issue)
2012-07-24 08:19:51 -04:00
end
end
# Update an existing issue
#
# Parameters:
# id (required) - The ID of a project
2012-07-24 08:19:51 -04:00
# issue_id (required) - The ID of a project issue
# title (optional) - The title of an issue
# description (optional) - The description of an issue
# assignee_id (optional) - The ID of a user to assign issue
# milestone_id (optional) - The ID of a milestone to assign issue
# labels (optional) - The labels of an issue
# state_event (optional) - The state event of an issue (close|reopen)
2016-04-05 13:05:55 -04:00
# updated_at (optional) - Date time string, ISO 8601 formatted
2016-07-12 11:59:21 -04:00
# due_date (optional) - Date time string in the format YEAR-MONTH-DAY
2016-07-15 10:21:53 -04:00
# confidential (optional) - Boolean parameter if the issue should be confidential
2012-07-24 08:19:51 -04:00
# Example Request:
# PUT /projects/:id/issues/:issue_id
2016-07-12 11:59:21 -04:00
put ':id/issues/:issue_id' do
issue = user_project.issues.find(params[:issue_id])
authorize! :update_issue, issue
2016-07-15 10:21:53 -04:00
keys = [:title, :description, :assignee_id, :milestone_id, :state_event, :due_date, :confidential]
2016-04-05 13:05:55 -04:00
keys << :updated_at if current_user.admin? || user_project.owner == current_user
attrs = attributes_for_keys(keys)
# Validate label names in advance
if (errors = validate_label_params(params)).any?
render_api_error!({ labels: errors }, 400)
end
attrs[:labels] = params[:labels] if params[:labels]
2016-07-15 10:21:53 -04:00
# Convert and filter out invalid confidential flags
attrs['confidential'] = to_boolean(attrs['confidential'])
attrs.delete('confidential') if attrs['confidential'].nil?
issue = ::Issues::UpdateService.new(user_project, current_user, attrs).execute(issue)
2013-06-11 11:15:18 -04:00
if issue.valid?
2016-04-08 02:41:10 -04:00
present issue, with: Entities::Issue, current_user: current_user
else
render_validation_error!(issue)
2012-07-24 08:19:51 -04:00
end
end
2016-04-07 08:07:17 -04:00
# Move an existing issue
#
# Parameters:
2016-04-12 12:38:18 -04:00
# id (required) - The ID of a project
# issue_id (required) - The ID of a project issue
# to_project_id (required) - The ID of the new project
2016-04-07 08:07:17 -04:00
# Example Request:
# POST /projects/:id/issues/:issue_id/move
2016-04-12 12:38:18 -04:00
post ':id/issues/:issue_id/move' do
required_attributes! [:to_project_id]
2016-04-07 08:07:17 -04:00
issue = user_project.issues.find(params[:issue_id])
2016-04-12 12:38:18 -04:00
new_project = Project.find(params[:to_project_id])
2016-04-07 08:07:17 -04:00
begin
issue = ::Issues::MoveService.new(user_project, current_user).execute(issue, new_project)
2016-04-12 12:38:18 -04:00
present issue, with: Entities::Issue, current_user: current_user
2016-04-07 08:07:17 -04:00
rescue ::Issues::MoveService::MoveError => error
render_api_error!(error.message, 400)
end
end
#
2016-02-26 03:55:43 -05:00
# Delete a project issue
2012-07-24 08:19:51 -04:00
#
# Parameters:
# id (required) - The ID of a project
2012-07-24 08:19:51 -04:00
# issue_id (required) - The ID of a project issue
# Example Request:
# DELETE /projects/:id/issues/:issue_id
delete ":id/issues/:issue_id" do
2016-03-21 09:12:52 -04:00
issue = user_project.issues.find_by(id: params[:issue_id])
2016-02-26 03:55:43 -05:00
2016-03-21 09:12:52 -04:00
authorize!(:destroy_issue, issue)
2016-02-26 03:55:43 -05:00
issue.destroy
2012-07-24 08:19:51 -04:00
end
end
end
end