Issue¶
Issue 用于跟踪缺陷、需求与讨论。通过 API 可以创建与更新 Issue,管理评论、标签与指派,关联分支和 Pull Request,并读取表态、修改历史与操作日志。
仓库级的标签、里程碑有独立分组,本页只覆盖 Issue 自身的接口。
对象¶
| 对象 | 说明 | 相关接口 |
|---|---|---|
| Issue | 标题、内容、状态、创建人、评论数、标签、里程碑 | 获取仓库的某个Issue |
| 评论 | Issue 下的讨论内容,可增删改查 | 创建Issue评论 |
| 标签 | Issue 上的标签,支持批量添加与删除 | 创建Issue标签 |
| 表态(reaction) | 用户对 Issue 或评论的 emoji 表态 | 获取issue的表态列表 |
| 关联分支 | 与 Issue 关联的分支列表 | 设置Issue关联的分支 |
| 关联 Pull Request | 该 Issue 关联的全部 PR | 获取 issue 关联的 pull requests |
| 看板字段 | Issue 关联的看板字段与取值 | 更新issue关联的看板字段 |
| 修改历史 | Issue 与评论的变更记录 | 获取issue的修改历史 |
| 操作日志 | Issue 上的操作流水 | 获取某个issue下的操作日志 |
标识方式¶
- 仓库级接口用
owner+repo标识仓库,用number标识 Issue 编号。 - 评论级接口用
id(或comment_id)标识具体评论,路径形如/issues/comments/{id}与/issues/comment/{comment_id}/…。 - 企业级接口改用
enterprise标识企业空间,路径以/api/v5/enterprises/{enterprise}/开头。 - 组织级接口用
org标识组织,路径以/api/v5/orgs/{org}/开头。
常见任务¶
注意事项¶
- 创建与更新 Issue 的路径只带
{owner},不带{repo}:POST /api/v5/repos/{owner}/issues、PATCH /api/v5/repos/{owner}/issues/{number},与同目录其他接口的/repos/{owner}/{repo}/…形态不同。 - 表态接口分散在两条路径上:Issue 的表态是
/issues/{number}/user_reactions,评论的表态是/issues/comment/{comment_id}/user_reactions,注意是单数comment。 - 删除标签时
{name}支持用英文逗号分隔多个标签名批量删除。 - 企业级 Issue 与仓库级 Issue 是两套接口(
/enterprises/{enterprise}/issues/…与/repos/{owner}/{repo}/issues/…),企业侧另有独立的 Issue 状态接口/enterprises/{enterprise}/issue/statuses。 - Issue 的标签、里程碑管理接口在各自分组,本组只负责在 Issue 上挂载与摘除。
接口列表¶
本模块共 28 个接口。
| # | 接口 | 方法与路径 | 说明 |
|---|---|---|---|
| 1 | 创建Issue | POST /api/v5/repos/{owner}/issues |
用户调用此接口,进行创建Issue操作. |
| 2 | 更新Issue | PATCH /api/v5/repos/{owner}/issues/{number} |
用户调用此接口,进行更新Issue操作. |
| 3 | 获取仓库的某个Issue | GET /api/v5/repos/{owner}/{repo}/issues/{number} |
该接口用于获取指定仓库中某个 Issue 的详细信息,包括标题、内容、状态、创建人、评论数、标签、里程碑及自定义字段… |
| 4 | 获取仓库所有 issues | GET /api/v5/repos/{owner}/{repo}/issues |
该接口用于获取指定仓库内的所有 issue 列表,支持按状态、标签、里程碑、指派人、创建者及时间范围等条件筛选,并可… |
| 5 | 获取仓库某个Issue所有的评论 | GET /api/v5/repos/{owner}/{repo}/issues/{number}/comments |
该接口用于获取指定仓库中某个 Issue 的全部评论,支持分页、排序及按起始更新时间筛选,返回每条评论的内容、发表用… |
| 6 | 创建Issue评论 | POST /api/v5/repos/{owner}/{repo}/issues/{number}/comments |
该接口用于在指定仓库的指定 Issue 下创建一条评论,通过提交评论内容完成评论创建,并返回新建评论的详细信息。 |
| 7 | 获取仓库所有 Issue 评论 | GET /api/v5/repos/{owner}/{repo}/issues/comments |
该接口用于获取指定仓库中所有 Issue 的评论,支持按创建或更新时间排序、指定排序方向以及分页查询,并可按时间筛选… |
| 8 | 获取 issue 关联的 pull requests | GET /api/v5/repos/{owner}/{repo}/issues/{number}/pull_requests |
该接口用于获取指定仓库下某个 Issue 关联的所有 Pull Request 列表,返回每个 PR 的编号、标题、… |
| 9 | 获取企业某个Issue所有标签 | GET /api/v5/enterprises/{enterprise}/issues/{number}/labels |
该接口用于获取企业指定 Issue 下的所有标签,返回标签的编号、名称、颜色及链接信息,并支持分页查询。 |
| 10 | 创建Issue标签 | POST /api/v5/repos/{owner}/{repo}/issues/{number}/labels |
该接口用于为指定仓库中的特定 Issue 创建标签。通过提交标签名称列表,可为该 Issue 添加一个或多个标签,并… |
| 11 | 删除Issue标签 | DELETE /api/v5/repos/{owner}/{repo}/issues/{number}/labels/{name} |
该接口用于删除指定仓库中某个 Issue 的标签,支持以英文逗号分隔多个标签名称进行批量删除,删除成功后返回空对象。 |
| 12 | 获取某个issue下的操作日志 | GET /api/v5/repos/{owner}/issues/{number}/operate_logs |
用户调用此接口,进行获取某个issue下的操作日志操作. |
| 13 | 获取某个企业的所有Issues | GET /api/v5/enterprises/{enterprise}/issues |
该接口用于获取指定企业的全部 Issue 列表,支持按状态、标签、里程碑、指派者、创建者及关键字等条件筛选,并可对结… |
| 14 | 获取授权用户的所有Issues | GET /api/v5/user/issues |
用户调用此接口,进行获取授权用户的所有Issues操作. |
| 15 | 更新Issue某条评论 | PATCH /api/v5/repos/{owner}/{repo}/issues/comments/{id} |
该接口用于更新指定仓库中 Issue 的某条评论内容,可提交新的评论正文替换原有评论,更新成功后返回空对象。 |
| 16 | 删除Issue某条评论 | DELETE /api/v5/repos/{owner}/{repo}/issues/comments/{id} |
该接口用于删除指定仓库中某个 Issue 下的特定评论,便于移除不需要或已过时的讨论内容,操作成功后该评论不再显示。 |
| 17 | 获取仓库Issue某条评论 | GET /api/v5/repos/{owner}/{repo}/issues/comments/{id} |
该接口用于获取指定仓库中某条 Issue 评论的详细信息,涵盖评论内容、评论类型、作者信息、关联的 Issue 信息… |
| 18 | 获取当前用户某个组织的Issues | GET /api/v5/orgs/{org}/issues |
该接口用于获取当前用户指定组织的 Issue 列表,支持按负责或创建来源、开启或关闭状态、标签、创建时间等条件筛选,… |
| 19 | 获取企业某个Issue所有评论 | GET /api/v5/enterprises/{enterprise}/issues/{number}/comments |
该接口用于获取指定企业下某个 Issue 的全部评论,支持分页查询。返回结果包含每条评论的内容、创建及更新时间、评论… |
| 20 | 获取企业的某个Issue | GET /api/v5/enterprises/{enterprise}/issues/{number} |
该接口用于获取企业下指定的某个 Issue,返回该 Issue 的详细信息,包括标题、内容、状态、标签、评论数、优先… |
| 21 | 获取企业issue状态 | GET /api/v5/enterprises/{enterprise}/issue/statuses |
该接口用于获取指定企业的 issue 状态列表。通过传入企业空间地址路径,可查询该企业下所有 issue 状态信息,… |
| 22 | 获取issue关联的分支列表 | GET /api/v5/repos/{owner}/{repo}/issues/{number}/related_branches |
该接口用于获取指定 issue 关联的分支列表,通过仓库所属空间地址、仓库路径和 Issue 编号进行查询,返回与该… |
| 23 | 获取issue的表态列表 | GET /api/v5/repos/{owner}/{repo}/issues/{number}/user_reactions |
该接口用于获取指定 Issue 下用户表态(reaction)的列表,支持按 emoji 表情筛选,并分页返回表态记… |
| 24 | 获取issue评论的表态列表 | GET /api/v5/repos/{owner}/{repo}/issues/comment/{comment_id}/user_reactions |
该接口用于获取指定 issue 评论的表态列表,返回用户对该评论的 emoji 表态记录,包含表态的 emoji 表… |
| 25 | 获取issue的修改历史 | GET /api/v5/repos/{owner}/{repo}/issues/{number}/modify_history |
该接口用于获取指定仓库下某个 Issue 的修改历史,每条记录包含修改后的内容、修改时间与操作者信息。 |
| 26 | 获取issue评论的修改历史 | GET /api/v5/repos/{owner}/{repo}/issues/comment/{comment_id}/modify_history |
该接口用于获取指定 issue 评论的修改历史记录,返回包含修改时间、修改后内容以及操作用户与被修改用户信息的历史记… |
| 27 | 设置Issue关联的分支 | PUT /api/v5/repos/{owner}/{repo}/issues/{number}/related_branches |
该接口用于为指定仓库的 Issue 设置关联的分支,提交分支名列表完成关联设置,并返回当前与 Issue 关联的分支… |
| 28 | 更新issue关联的看板字段 | PUT /api/v5/repos/{owner}/{repo}/issues/{number}/kanban_values |
该接口用于更新指定 issue 关联的看板字段,通过指定看板标识(kanban_id)并提交字段名称及对应的字段值列… |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc