Milestone¶
里程碑（Milestone）用于把 Issue 与 Pull Request 归到同一个交付目标下。通过 API 可以创建、查询、更新与删除仓库里程碑。
企业级的里程碑有独立分组（Enterprise），本组只覆盖仓库里程碑。
对象¶
| 对象 | 说明 | 相关接口 |
|---|---|---|
| 里程碑 | 标题、描述、截止日期、开启/完成状态、完成度 | 获取仓库所有里程碑 |
标识方式¶
- 仓库用
owner+repo，里程碑用number标识。 - 里程碑编号在仓库内唯一，与 Issue 编号是两套序列。
常见任务¶
注意事项¶
- 更新用的方法是
PATCH（不是PUT），只提交要改的字段即可。 - 里程碑只按仓库维度定义；企业里程碑、企业 Issue 自定义字段在 Enterprise 分组里。
- 把 Issue 挂到某个里程碑，是在 Issue 的更新接口里传里程碑字段，本组不提供关联接口。
接口列表¶
本模块共 5 个接口。
| # | 接口 | 方法与路径 | 说明 |
|---|---|---|---|
| 1 | 获取仓库所有里程碑 | GET /api/v5/repos/{owner}/{repo}/milestones |
该接口用于获取指定仓库的全部里程碑，支持按状态筛选（开放、关闭或全部），并可依据截止日期排序及分页查看，返回里程碑的… |
| 2 | 创建仓库里程碑 | POST /api/v5/repos/{owner}/{repo}/milestones |
该接口用于在指定仓库中创建里程碑，支持设置里程碑标题、具体描述、截止日期及状态，并返回创建后的里程碑完整信息。 |
| 3 | 获取仓库单个里程碑 | GET /api/v5/repos/{owner}/{repo}/milestones/{number} |
该接口用于获取指定仓库中单个里程碑的详细信息，包括里程碑标题、描述、状态、截止日期、创建及更新时间，以及关联的已关闭… |
| 4 | 删除仓库单个里程碑 | DELETE /api/v5/repos/{owner}/{repo}/milestones/{number} |
该接口用于删除指定仓库中的单个里程碑。删除成功后返回空响应体；若目标里程碑不存在，则返回404错误提示。 |
| 5 | 更新仓库里程碑 | PATCH /api/v5/repos/{owner}/{repo}/milestones/{number} |
该接口用于更新指定仓库中的里程碑信息，可修改里程碑的标题、状态、具体描述及截止日期，并返回更新后的里程碑详情。 |
本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc