deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add milestone API docs to doc/README and views/help/api

Browse source 
Also removes `closed` attribute option from create action.
This commit is contained in:
Robert Speicher 2012-08-29 08:45:00 -04:00
parent 8d192adb38
commit 8a49cdc3b4
4 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
app/views/help/api.html.haml
View file

@ -63,3 +63,13 @@
.file_content.wiki .file_content.wiki
= preserve do = preserve do
= markdown File.read(Rails.root.join("doc", "api", "issues.md")) = markdown File.read(Rails.root.join("doc", "api", "issues.md"))
%br
.file_holder#milestones
.file_title
%i.icon-file
Milestones
.file_content.wiki
= preserve do
= markdown File.read(Rails.root.join("doc", "api", "milestones.md"))

1
doc/api/README.md
View file

@ -29,3 +29,4 @@ The API uses JSON to serialize data. You don't need to specify `.json` at the en
+ [Projects](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md) + [Projects](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md)
+ [Snippets](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/snippets.md) + [Snippets](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/snippets.md)
+ [Issues](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md) + [Issues](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md)
+ [Milestones](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/milestones.md)

2
doc/api/milestones.md
View file

@ -34,10 +34,10 @@ POST /projects/:id/milestones
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID or code name of a project
+ `milestone_id` (required) - The ID of a project milestone
+ `title` (required) - The title of an milestone + `title` (required) - The title of an milestone
+ `description` (optional) - The description of the milestone + `description` (optional) - The description of the milestone
+ `due_date` (optional) - The due date of the milestone + `due_date` (optional) - The due date of the milestone
+ `closed` (optional) - The status of the milestone
## Edit milestone ## Edit milestone

5
lib/api/milestones.rb
View file

@ -33,15 +33,13 @@ module Gitlab
# title (required) - The title of the milestone # title (required) - The title of the milestone
# description (optional) - The description of the milestone # description (optional) - The description of the milestone
# due_date (optional) - The due date of the milestone # due_date (optional) - The due date of the milestone
# closed (optional) - The status of the milestone
# Example Request: # Example Request:
# POST /projects/:id/milestones # POST /projects/:id/milestones
post ":id/milestones" do post ":id/milestones" do
@milestone = user_project.milestones.new( @milestone = user_project.milestones.new(
title: params[:title], title: params[:title],
description: params[:description], description: params[:description],
due_date: params[:due_date], due_date: params[:due_date]
closed: (params[:closed] || false)
) )
if @milestone.save if @milestone.save
@ -55,6 +53,7 @@ module Gitlab
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID or code name of a project
# milestone_id (required) - The ID of a project milestone
# title (optional) - The title of a milestone # title (optional) - The title of a milestone
# description (optional) - The description of a milestone # description (optional) - The description of a milestone
# due_date (optional) - The due date of a milestone # due_date (optional) - The due date of a milestone