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

Merge pull request #1328 from NARKOZ/api

Browse source 
add docs for Milestones API
This commit is contained in:
Dmitriy Zaporozhets 2012-08-29 05:36:01 -07:00
parent 14f5d1727a 2458060120
commit 8d192adb38
1 changed files with 57 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
doc/api/milestones.md Normal file
View file

@ -0,0 +1,57 @@
## List project milestones
Get a list of project milestones.
```
GET /projects/:id/milestones
```
Parameters:
+ `id` (required) - The ID or code name of a project
## Single milestone
Get a single project milestone.
```
GET /projects/:id/milestones/:milestone_id
```
Parameters:
+ `id` (required) - The ID or code name of a project
+ `milestone_id` (required) - The ID of a project milestone
## New milestone
Create a new project milestone.
```
POST /projects/:id/milestones
```
Parameters:
+ `id` (required) - The ID or code name of a project
+ `title` (required) - The title of an milestone
+ `description` (optional) - The description of the milestone
+ `due_date` (optional) - The due date of the milestone
+ `closed` (optional) - The status of the milestone
## Edit milestone
Update an existing project milestone.
```
PUT /projects/:id/milestones/:milestone_id
```
Parameters:
+ `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
+ `description` (optional) - The description of a milestone
+ `due_date` (optional) - The due date of the milestone
+ `closed` (optional) - The status of the milestone