gitlab-org--gitlab-foss/doc/api/milestones.md

77 lines
1.4 KiB
Markdown
Raw Normal View History

2012-08-29 08:31:00 -04:00
## List project milestones
Returns a list of project milestones.
2012-08-29 08:31:00 -04:00
```
GET /projects/:id/milestones
```
```json
[
{
"id":12,
2013-10-14 09:40:16 -04:00
"iid":3,
"project_id":16,
"title":"10.0",
"description":"Version",
"due_date":"2013-11-29",
"state":"active",
"updated_at":"2013-10-02T09:24:18Z",
"created_at":"2013-10-02T09:24:18Z"
}
]
```
2012-08-29 08:31:00 -04:00
Parameters:
+ `id` (required) - The ID of a project
2012-08-29 08:31:00 -04:00
## Get single milestone
Gets a single project milestone.
2012-08-29 08:31:00 -04:00
```
GET /projects/:id/milestones/:milestone_id
```
Parameters:
+ `id` (required) - The ID of a project
2012-08-29 08:31:00 -04:00
+ `milestone_id` (required) - The ID of a project milestone
## Create new milestone
2012-08-29 08:31:00 -04:00
Creates a new project milestone.
2012-08-29 08:31:00 -04:00
```
POST /projects/:id/milestones
```
Parameters:
+ `id` (required) - The ID of a project
2012-08-29 08:31:00 -04:00
+ `title` (required) - The title of an milestone
+ `description` (optional) - The description of the milestone
+ `due_date` (optional) - The due date of the milestone
2012-08-29 08:31:00 -04:00
## Edit milestone
Updates an existing project milestone.
2012-08-29 08:31:00 -04:00
```
PUT /projects/:id/milestones/:milestone_id
```
Parameters:
+ `id` (required) - The ID of a project
2012-08-29 08:31:00 -04:00
+ `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
+ `state_event` (optional) - The state event of the milestone (close|activate)