Project milestones API
- List project milestones
- Get single milestone
- Create new milestone
- Edit milestone
- Delete project milestone
- Get all issues assigned to a single milestone
- Get all merge requests assigned to a single milestone
- Promote project milestone to a group milestone
- Get all burndown chart events for a single milestone
Project milestones API
This page describes the project milestones API. There’s a separate group milestones API page.
List project milestones
返回项目里程碑的列表.
GET /projects/:id/milestones
GET /projects/:id/milestones?iids[]=42
GET /projects/:id/milestones?iids[]=42&iids[]=43
GET /projects/:id/milestones?state=active
GET /projects/:id/milestones?state=closed
GET /projects/:id/milestones?title=1.0
GET /projects/:id/milestones?search=version
Parameters:
Attribute | Type | Required | Description |
---|---|---|---|
id |
integer/string | yes | 经过身份验证的用户拥有的项目的 ID 或URL 编码路径 |
iids[] |
整数数组 | optional | 仅返回具有给定iid 的里程碑 |
state |
string | optional | 仅返回active 或closed 里程碑 |
title |
string | optional | 仅返回具有给定title 的里程碑 |
search |
string | optional | 仅返回标题或描述与提供的字符串匹配的里程碑 |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/milestones"
示例响应:
[ { "id": 12, "iid": 3, "project_id": 16, "title": "10.0", "description": "Version", "due_date": "2013-11-29", "start_date": "2013-11-10", "state": "active", "updated_at": "2013-10-02T09:24:18Z", "created_at": "2013-10-02T09:24:18Z" } ]
Get single milestone
获得单个项目里程碑.
GET /projects/:id/milestones/:milestone_id
Parameters:
Create new milestone
创建一个新的项目里程碑.
POST /projects/:id/milestones
Parameters:
id
(必填)-经过身份验证的用户拥有的项目的 ID 或URL 编码路径title
(必填)-里程碑的标题description
(可选)-里程碑的说明due_date
(可选)-里程碑的截止日期start_date
(可选)-里程碑的开始日期
Edit milestone
更新现有项目的里程碑.
PUT /projects/:id/milestones/:milestone_id
Parameters:
id
(必填)-经过身份验证的用户拥有的项目的 ID 或URL 编码路径milestone_id
(必填)-项目里程碑的 IDtitle
(可选)-里程碑的标题description
(可选)-里程碑的说明due_date
(可选)-里程碑的截止日期start_date
(可选)-里程碑的开始日期state_event
(可选)-里程碑的状态事件(关闭或激活)
Delete project milestone
仅适用于具有开发人员访问项目权限的用户.
DELETE /projects/:id/milestones/:milestone_id
Parameters:
Get all issues assigned to a single milestone
获取分配给单个项目里程碑的所有问题.
GET /projects/:id/milestones/:milestone_id/issues
Parameters:
Get all merge requests assigned to a single milestone
获取分配给单个项目里程碑的所有合并请求.
GET /projects/:id/milestones/:milestone_id/merge_requests
Parameters:
Promote project milestone to a group milestone
在 GitLab 11.9 中引入
仅针对具有开发者访问权限的用户.
POST /projects/:id/milestones/:milestone_id/promote
Parameters:
Get all burndown chart events for a single milestone
在 GitLab 12.1 中引入
获取单个里程碑的所有燃尽图事件.
GET /projects/:id/milestones/:milestone_id/burndown_events
Parameters: