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

182 lines
6.6 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
2014-08-14 10:17:19 -04:00
issues = current_user.issues
issues = filter_issues_state(issues, params[:state]) unless params[:state].nil?
issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].nil?
issues.reorder(issuable_order_by => issuable_sort)
2014-08-14 10:17:19 -04:00
present paginate(issues), with: Entities::Issue
2012-07-24 08:19:51 -04:00
end
end
resource :projects do
# Get a list of project issues
#
# Parameters:
# id (required) - The ID of a project
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
2012-07-24 08:19:51 -04:00
get ":id/issues" do
2014-08-14 10:17:19 -04:00
issues = user_project.issues
issues = filter_issues_state(issues, params[:state]) unless params[:state].nil?
issues = filter_issues_labels(issues, params[:labels]) unless params[:labels].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
issues.reorder(issuable_order_by => issuable_sort)
2014-08-14 10:17:19 -04:00
present paginate(issues), with: Entities::Issue
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 = user_project.issues.find(params[:issue_id])
present @issue, with: Entities::Issue
2012-07-24 08:19:51 -04:00
end
# Create a new project issue
#
# Parameters:
# id (required) - The ID of a project
2012-07-24 08:19:51 -04:00
# 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
# milestone_id (optional) - The ID of a milestone to assign issue
# labels (optional) - The labels of an issue
# Example Request:
# POST /projects/:id/issues
post ":id/issues" do
required_attributes! [:title]
attrs = attributes_for_keys [:title, :description, :assignee_id, :milestone_id]
# Validate label names in advance
if (errors = validate_label_params(params)).any?
render_api_error!({ labels: errors }, 400)
end
issue = ::Issues::CreateService.new(user_project, current_user, attrs).execute
if issue.valid?
# Find or create labels and attach to issue. Labels are valid because
# we already checked its name, so there can't be an error here
if params[:labels].present?
issue.add_labels_by_names(params[:labels].split(','))
end
present issue, with: Entities::Issue
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)
2012-07-24 08:19:51 -04:00
# Example Request:
# PUT /projects/:id/issues/:issue_id
put ":id/issues/:issue_id" do
issue = user_project.issues.find(params[:issue_id])
authorize! :modify_issue, issue
attrs = attributes_for_keys [:title, :description, :assignee_id, :milestone_id, :state_event]
# Validate label names in advance
if (errors = validate_label_params(params)).any?
render_api_error!({ labels: errors }, 400)
end
issue = ::Issues::UpdateService.new(user_project, current_user, attrs).execute(issue)
2013-06-11 11:15:18 -04:00
if issue.valid?
# Find or create labels and attach to issue. Labels are valid because
# we already checked its name, so there can't be an error here
unless params[:labels].nil?
issue.remove_labels
# Create and add labels to the new created issue
issue.add_labels_by_names(params[:labels].split(','))
end
present issue, with: Entities::Issue
else
render_validation_error!(issue)
2012-07-24 08:19:51 -04:00
end
end
# Delete a project issue (deprecated)
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
2012-09-10 03:41:46 -04:00
not_allowed!
2012-07-24 08:19:51 -04:00
end
end
end
end