debian-mirror-gitlab/doc/api/milestones.md

134 lines
3.7 KiB
Markdown
Raw Normal View History

2017-09-10 17:25:29 +05:30
# Milestones API
2014-09-02 18:07:02 +05:30
## List project milestones
Returns a list of project milestones.
```
GET /projects/:id/milestones
2017-09-10 17:25:29 +05:30
GET /projects/:id/milestones?iids[]=42
2017-08-17 22:00:37 +05:30
GET /projects/:id/milestones?iids[]=42&iids[]=43
2016-06-02 11:05:42 +05:30
GET /projects/:id/milestones?state=active
GET /projects/:id/milestones?state=closed
2017-08-17 22:00:37 +05:30
GET /projects/:id/milestones?search=version
2014-09-02 18:07:02 +05:30
```
2016-06-02 11:05:42 +05:30
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
2017-09-10 17:25:29 +05:30
| `iids[]` | Array[integer] | optional | Return only the milestones having the given `iid` |
2018-12-05 23:21:45 +05:30
| `state` | string | optional | Return only `active` or `closed` milestones |
2017-08-17 22:00:37 +05:30
| `search` | string | optional | Return only milestones with a title or description matching the provided string |
2016-06-02 11:05:42 +05:30
```bash
2017-08-17 22:00:37 +05:30
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/milestones
2016-06-02 11:05:42 +05:30
```
Example Response:
2014-09-02 18:07:02 +05:30
```json
[
{
"id": 12,
"iid": 3,
"project_id": 16,
"title": "10.0",
"description": "Version",
"due_date": "2013-11-29",
2017-08-17 22:00:37 +05:30
"start_date": "2013-11-10",
2014-09-02 18:07:02 +05:30
"state": "active",
"updated_at": "2013-10-02T09:24:18Z",
"created_at": "2013-10-02T09:24:18Z"
}
]
```
## Get single milestone
Gets a single project milestone.
```
GET /projects/:id/milestones/:milestone_id
```
Parameters:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `milestone_id` (required) - The ID of the project's milestone
2014-09-02 18:07:02 +05:30
## Create new milestone
Creates a new project milestone.
```
POST /projects/:id/milestones
```
Parameters:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
2018-03-17 18:26:18 +05:30
- `title` (required) - The title of a milestone
2014-09-02 18:07:02 +05:30
- `description` (optional) - The description of the milestone
- `due_date` (optional) - The due date of the milestone
2017-08-17 22:00:37 +05:30
- `start_date` (optional) - The start date of the milestone
2014-09-02 18:07:02 +05:30
## Edit milestone
Updates an existing project milestone.
```
PUT /projects/:id/milestones/:milestone_id
```
Parameters:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
2014-09-02 18:07:02 +05:30
- `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
2017-08-17 22:00:37 +05:30
- `start_date` (optional) - The start date of the milestone
2014-09-02 18:07:02 +05:30
- `state_event` (optional) - The state event of the milestone (close|activate)
2015-04-26 12:48:37 +05:30
2018-03-17 18:26:18 +05:30
## Delete project milestone
Only for user with developer access to the project.
```
DELETE /projects/:id/milestones/:milestone_id
```
Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `milestone_id` (required) - The ID of the project's milestone
2015-04-26 12:48:37 +05:30
## 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:
2017-08-17 22:00:37 +05:30
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `milestone_id` (required) - The ID of a project milestone
## Get all merge requests assigned to a single milestone
Gets all merge requests assigned to a single project milestone.
```
GET /projects/:id/milestones/:milestone_id/merge_requests
```
Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
2015-04-26 12:48:37 +05:30
- `milestone_id` (required) - The ID of a project milestone