7499f65014
Added a helper method to check if required parameters are given in an API call. Can be used to return a `400 Bad Request` return code if a required attribute is missing. Code clean up and fixed tests.
102 lines
3.3 KiB
Ruby
102 lines
3.3 KiB
Ruby
module Gitlab
|
|
# Issues API
|
|
class Issues < Grape::API
|
|
before { authenticate! }
|
|
|
|
resource :issues do
|
|
# Get currently authenticated user's issues
|
|
#
|
|
# Example Request:
|
|
# GET /issues
|
|
get do
|
|
present paginate(current_user.issues), with: Entities::Issue
|
|
end
|
|
end
|
|
|
|
resource :projects do
|
|
# Get a list of project issues
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# Example Request:
|
|
# GET /projects/:id/issues
|
|
get ":id/issues" do
|
|
present paginate(user_project.issues), with: Entities::Issue
|
|
end
|
|
|
|
# Get a single project issue
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# 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
|
|
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
|
|
# 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]
|
|
attrs[:label_list] = params[:labels] if params[:labels].present?
|
|
@issue = user_project.issues.new attrs
|
|
@issue.author = current_user
|
|
if @issue.save
|
|
present @issue, with: Entities::Issue
|
|
else
|
|
not_found!
|
|
end
|
|
end
|
|
|
|
# Update an existing issue
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# 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 (optional) - The state of an issue (close|reopen)
|
|
# 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]
|
|
attrs[:label_list] = params[:labels] if params[:labels].present?
|
|
IssueObserver.current_user = current_user
|
|
if @issue.update_attributes attrs
|
|
present @issue, with: Entities::Issue
|
|
else
|
|
not_found!
|
|
end
|
|
end
|
|
|
|
# Delete a project issue (deprecated)
|
|
#
|
|
# Parameters:
|
|
# id (required) - The ID of a project
|
|
# issue_id (required) - The ID of a project issue
|
|
# Example Request:
|
|
# DELETE /projects/:id/issues/:issue_id
|
|
delete ":id/issues/:issue_id" do
|
|
not_allowed!
|
|
end
|
|
end
|
|
end
|
|
end
|