Labels¶
标签（Label）用于给 Issue、Pull Request 分类。通过 API 可以创建、更新、删除仓库的任务标签，批量替换仓库或某个 Issue 的标签集合，并查询企业级标签。
对象¶
| 对象 | 说明 | 相关接口 |
|---|---|---|
| 任务标签 | 仓库内的标签定义：名称、颜色、描述 | 获取仓库的任务标签列表 |
| 仓库标签集合 | 整体替换仓库的标签列表 | 替换所有仓库标签 |
| Issue 标签集合 | 替换或清空某个 Issue 的全部标签 | 替换Issue所有标签 |
| 企业标签 | 企业空间下的标签定义 | 获取所有企业标签 |
标识方式¶
- 仓库用
owner+repo；标签用original_name（改名时用它定位原标签）或标签名标识。 - Issue 用
number，企业用enterprise。
常见任务¶
注意事项¶
- 替换仓库全部标签用的是
PUT …/project_labels，不是…/labels；单个标签的增删改才走/labels。 - 删除任务标签的路径用
*占位：DELETE /api/v5/repos/*/*/labels/*，与其他{owner}/{repo}写法不一致。 - 企业标签有两个接口分属不同版本前缀：
GET /api/v5/enterprises/{enterprise}/labels与GET /api/v8/enterprises/{enterprise}/labels，字段可能不同，按需选。 - 改名时用
original_name定位，改完名字后后续调用要用新名。 - Issue 与 PR 标签的挂载接口在各自的 Issue、Pull Request 分组，本组只管标签本身的定义与整体替换。
接口列表¶
本模块共 9 个接口。
| # | 接口 | 方法与路径 | 说明 |
|---|---|---|---|
| 1 | 替换所有仓库标签 | PUT /api/v5/repos/{owner}/{repo}/project_labels |
该接口用于替换指定仓库的全部标签：传入新的标签名称列表即可整体覆盖原有标签，标签名会被统一转为小写并去重，传空数组则… |
| 2 | 删除Issue所有标签 | DELETE /api/v5/repos/{owner}/{repo}/issues/{number}/labels |
该接口用于删除指定仓库中某个 Issue 的所有标签，通过仓库空间地址和 Issue 编号定位目标，删除成功后返回空… |
| 3 | 替换Issue所有标签 | PUT /api/v5/repos/{owner}/{repo}/issues/{number}/labels |
该接口用于替换指定仓库中指定 Issue 的全部标签。请求体为标签名称组成的字符串数组，替换后该 Issue 的标签… |
| 4 | 更新仓库的任务标签 | PATCH /api/v5/repos/{owner}/{repo}/labels/{original_name} |
该接口用于更新指定仓库的任务标签，以标签原有名称定位目标标签，支持修改标签的新名称与颜色，更新成功后返回标签的 ID… |
| 5 | 获取仓库所有任务标签 | GET /api/v5/repos/{owner}/{repo}/labels |
该接口用于获取指定仓库中的所有任务标签，返回标签的 ID、名称、颜色及所属仓库 ID 等信息，并支持通过分页参数控制… |
| 6 | 创建仓库任务标签 | POST /api/v5/repos/{owner}/{repo}/labels |
该接口用于在指定仓库下创建一个任务标签，提交标签名称和颜色即可完成创建，创建成功后返回该标签的标识、名称与颜色信息。 |
| 7 | 删除仓库任务标签 | DELETE /api/v5/repos/*/*/labels/* |
该接口用于删除指定仓库中的任务标签。通过传入仓库所属空间地址、仓库路径及标签名称，即可将对应标签从仓库中删除，删除成… |
| 8 | 获取企业所有的标签 | GET /api/v5/enterprises/{enterprise}/labels |
该接口用于获取指定企业的全部标签，支持分页查询，每页数量最大为 100。返回结果为标签列表，包含标签 ID、名称、颜… |
| 9 | 获取标签列表 | GET /api/v8/enterprises/{enterprise}/labels |
用户调用此接口,进行获取标签列表操作. |
本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc