Add API for Milestones
This commit is contained in:
parent
05da3801f5
commit
b0a901fe01
3 changed files with 147 additions and 0 deletions
93
lib/api/milestones.rb
Normal file
93
lib/api/milestones.rb
Normal file
|
@ -0,0 +1,93 @@
|
|||
module Gitlab
|
||||
# Milestones API
|
||||
class Milestones < Grape::API
|
||||
before { authenticate! }
|
||||
|
||||
resource :projects do
|
||||
# Get a list of project milestones
|
||||
#
|
||||
# Parameters:
|
||||
# id (required) - The ID or code name of a project
|
||||
# Example Request:
|
||||
# GET /projects/:id/milestones
|
||||
get ":id/milestones" do
|
||||
present user_project.milestones, with: Entities::Milestone
|
||||
end
|
||||
|
||||
# Get a single project milestone
|
||||
#
|
||||
# Parameters:
|
||||
# id (required) - The ID or code name of a project
|
||||
# milestone_id (required) - The ID of a project milestone
|
||||
# Example Request:
|
||||
# GET /projects/:id/milestones/:milestone_id
|
||||
get ":id/milestones/:milestone_id" do
|
||||
@milestone = user_project.milestones.find(params[:milestone_id])
|
||||
present @milestone, with: Entities::Milestone
|
||||
end
|
||||
|
||||
# Create a new project milestone
|
||||
#
|
||||
# Parameters:
|
||||
# id (required) - The ID or code name of the project
|
||||
# title (required) - The title of the milestone
|
||||
# description (optional) - The description of the milestone
|
||||
# due_date (optional) - The due date of the milestone
|
||||
# closed (optional) - The status of the milestone
|
||||
# Example Request:
|
||||
# POST /projects/:id/milestones
|
||||
post ":id/milestones" do
|
||||
@milestone = user_project.milestones.new(
|
||||
title: params[:title],
|
||||
description: params[:description],
|
||||
due_date: params[:due_date],
|
||||
closed: (params[:closed] || false)
|
||||
)
|
||||
|
||||
if @milestone.save
|
||||
present @milestone, with: Entities::Milestone
|
||||
else
|
||||
error!({'message' => '404 Not found'}, 404)
|
||||
end
|
||||
end
|
||||
|
||||
# Update an existing project milestone
|
||||
#
|
||||
# Parameters:
|
||||
# id (required) - The ID or code name of a project
|
||||
# title (optional) - The title of a milestone
|
||||
# description (optional) - The description of a milestone
|
||||
# due_date (optional) - The due date of a milestone
|
||||
# closed (optional) - The status of the milestone
|
||||
# Example Request:
|
||||
# PUT /projects/:id/milestones/:milestone_id
|
||||
put ":id/milestones/:milestone_id" do
|
||||
@milestone = user_project.milestones.find(params[:milestone_id])
|
||||
parameters = {
|
||||
title: (params[:title] || @milestone.title),
|
||||
description: (params[:description] || @milestone.description),
|
||||
due_date: (params[:due_date] || @milestone.due_date),
|
||||
closed: (params[:closed] || @milestone.closed)
|
||||
}
|
||||
|
||||
if @milestone.update_attributes(parameters)
|
||||
present @milestone, with: Entities::Milestone
|
||||
else
|
||||
error!({'message' => '404 Not found'}, 404)
|
||||
end
|
||||
end
|
||||
|
||||
# Delete a project milestone
|
||||
#
|
||||
# Parameters:
|
||||
# id (required) - The ID or code name of a project
|
||||
# milestone_id (required) - The ID of a project milestone
|
||||
# Example Request:
|
||||
# DELETE /projects/:id/milestones/:milestone_id
|
||||
delete ":id/milestones/:milestone_id" do
|
||||
@milestone = user_project.milestones.find(params[:milestone_id])
|
||||
@milestone.destroy
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
Loading…
Add table
Add a link
Reference in a new issue