BigW Consortium Gitlab

milestones.md 1.78 KB
Newer Older
1 2
# Milestones

3 4
## List project milestones

5
Returns a list of project milestones.
6 7 8

```
GET /projects/:id/milestones
9
GET /projects/:id/milestones?iid=42
10 11
```

12 13 14
```json
[
  {
15 16 17 18 19 20 21 22 23
    "id": 12,
    "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"
24 25 26 27
  }
]
```

28 29
Parameters:

30
- `id` (required) - The ID of a project
31
- `iid` (optional) - Return the milestone having the given `iid`
32 33 34 35

## Get single milestone

Gets a single project milestone.
36 37 38 39 40 41 42

```
GET /projects/:id/milestones/:milestone_id
```

Parameters:

43 44
- `id` (required) - The ID of a project
- `milestone_id` (required) - The ID of a project milestone
45 46

## Create new milestone
47

48
Creates a new project milestone.
49 50 51 52 53 54 55

```
POST /projects/:id/milestones
```

Parameters:

56 57 58 59
- `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
60

61 62
## Edit milestone

63
Updates an existing project milestone.
64 65 66 67 68 69 70

```
PUT /projects/:id/milestones/:milestone_id
```

Parameters:

71 72 73 74 75 76
- `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
- `state_event` (optional) - The state event of the milestone (close|activate)
77 78 79 80 81 82 83 84 85 86 87 88 89

## Get all issues assigned to a single milestone

Gets all issues assigned to a single project milestone.

```
GET /projects/:id/milestones/:milestone_id/issues
```

Parameters:

- `id` (required) - The ID of a project
- `milestone_id` (required) - The ID of a project milestone