gitlabhq/doc/api/milestones.md
Sebastian Ziebell 39114d259c API: documentation contains infos to status codes in README file.
All the info to return codes from the API functions are available in the `README.md` file as suggested.
2013-03-07 00:15:57 +01:00

61 lines
1.1 KiB
Markdown

## List project milestones
Returns a list of project milestones.
```
GET /projects/:id/milestones
```
Parameters:
+ `id` (required) - The ID of a project
## Get single milestone
Gets a single project milestone.
```
GET /projects/:id/milestones/:milestone_id
```
Parameters:
+ `id` (required) - The ID of a project
+ `milestone_id` (required) - The ID of a project milestone
## Create new milestone
Creates a new project milestone.
```
POST /projects/:id/milestones
```
Parameters:
+ `id` (required) - The ID 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
## Edit milestone
Updates an existing project milestone.
```
PUT /projects/:id/milestones/:milestone_id
```
Parameters:
+ `id` (required) - The ID 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