summaryrefslogtreecommitdiff
path: root/doc/api/milestones.md
blob: f68d8eb7d58ebb6802dfd189b071d709d0aa6b69 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
+ `milestone_id` (required) - The ID of a project milestone
+ `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

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