gitlabhq/lib/api/issues.rb

111 lines
3.6 KiB
Ruby
Raw Normal View History

2012-07-24 14:19:51 +02:00
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 current_user.issues, with: Entities::Issue
2012-07-24 14:19:51 +02:00
end
end
resource :projects do
# Get a list of project issues
#
# Parameters:
2012-07-25 11:35:41 +02:00
# id (required) - The ID or code name of a project
2012-07-24 14:19:51 +02:00
# Example Request:
# GET /projects/:id/issues
get ":id/issues" do
present user_project.issues, with: Entities::Issue
2012-07-24 14:19:51 +02:00
end
# Get a single project issue
#
# Parameters:
2012-07-25 11:35:41 +02:00
# id (required) - The ID or code name of a project
2012-07-24 14:19:51 +02: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 14:19:51 +02:00
end
# Create a new project issue
#
# Parameters:
2012-07-25 11:35:41 +02:00
# id (required) - The ID or code name of a project
2012-07-24 14:19:51 +02: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
@issue = user_project.issues.new(
title: params[:title],
description: params[:description],
assignee_id: params[:assignee_id],
milestone_id: params[:milestone_id],
label_list: params[:labels]
2012-07-24 14:19:51 +02:00
)
@issue.author = current_user
if @issue.save
present @issue, with: Entities::Issue
2012-07-24 14:19:51 +02:00
else
error!({'message' => '404 Not found'}, 404)
end
end
# Update an existing issue
#
# Parameters:
2012-07-25 11:35:41 +02:00
# id (required) - The ID or code name of a project
2012-07-24 14:19:51 +02: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
# closed (optional) - The state of an issue (0 = false, 1 = true)
# Example Request:
# PUT /projects/:id/issues/:issue_id
put ":id/issues/:issue_id" do
@issue = user_project.issues.find(params[:issue_id])
parameters = {
title: (params[:title] || @issue.title),
description: (params[:description] || @issue.description),
assignee_id: (params[:assignee_id] || @issue.assignee_id),
milestone_id: (params[:milestone_id] || @issue.milestone_id),
label_list: (params[:labels] || @issue.label_list),
closed: (params[:closed] || @issue.closed)
2012-07-24 14:19:51 +02:00
}
if @issue.update_attributes(parameters)
present @issue, with: Entities::Issue
2012-07-24 14:19:51 +02:00
else
error!({'message' => '404 Not found'}, 404)
end
end
# Delete a project issue (deprecated)
2012-07-24 14:19:51 +02:00
#
# Parameters:
2012-07-25 11:35:41 +02:00
# id (required) - The ID or code name of a project
2012-07-24 14:19:51 +02:00
# issue_id (required) - The ID of a project issue
# Example Request:
# DELETE /projects/:id/issues/:issue_id
delete ":id/issues/:issue_id" do
error!({'message' => 'method not allowed'}, 405)
2012-07-24 14:19:51 +02:00
end
end
end
end