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

105 lines
3.3 KiB
Ruby
Raw Normal View History

module API
2012-07-24 08:19:51 -04:00
# Issues API
class Issues < Grape::API
before { authenticate! }
resource :issues do
# Get currently authenticated user's issues
#
# Example Request:
# GET /issues
get do
2012-09-03 07:46:29 -04:00
present paginate(current_user.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
2012-07-24 08:19:51 -04:00
# Example Request:
# GET /projects/:id/issues
get ":id/issues" do
2012-09-03 07:46:29 -04:00
present paginate(user_project.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]
attrs[:label_list] = params[:labels] if params[:labels].present?
issue = ::Issues::CreateService.new(user_project, current_user, attrs).execute
if issue.valid?
present issue, with: Entities::Issue
else
not_found!
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
2012-09-10 02:06:11 -04:00
attrs = attributes_for_keys [:title, :description, :assignee_id, :milestone_id, :state_event]
attrs[:label_list] = params[:labels] if params[:labels].present?
issue = ::Issues::UpdateService.new(user_project, current_user, attrs).execute(issue)
2013-06-11 11:15:18 -04:00
if issue.valid?
present issue, with: Entities::Issue
else
not_found!
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