Pull Request¶

Pull Request（合并请求）用于把源分支的改动合入目标分支。通过 API 可以创建、更新、合并 PR，管理评论与标签，指派审查人、测试人和合并人，读取变更文件、Commit 与操作日志。

仓库级的标签、里程碑有独立分组，本页只覆盖 PR 自身的接口。

对象¶

标识方式¶

• 仓库级接口用 owner + repo 标识仓库，用 number 标识 PR 编号。
• 评论用 id 标识（路径 /pulls/comments/{id}），检视意见与回复用 discussion_id、comment_id 标识。
• 组织级接口用 org，路径为 /api/v5/org/{org}/pull_requests（单数 org）。
• 企业级接口用 enterprise，列表接口的路径里用 * 占位。

常见任务¶

注意事项¶

• 组织级 PR 列表的路径是 GET /api/v5/org/{org}/pull_requests，用单数 org，与其他 /orgs/{org}/… 接口不同；企业级列表用 GET /api/v5/enterprises/*/pull_requests，路径里是 * 占位。
• 评论有两类路径：按 PR 操作的 /pulls/{number}/comments（支持行级与文件级评论），以及按评论 ID 操作的 /pulls/comments/{id}。
• 回复评论要带讨论 ID：POST /pulls/{number}/discussions/{discussion_id}/comments；而修改检视意见的解决状态用的是 PUT /pulls/{number}/comments/{discussion_id}，路径里传的是 discussion_id 而不是评论 ID。
• 审查相关的接口有两组并存：/pulls/{number}/assignees 与 /pulls/{number}/reviewers，前者带重置审查状态的语义、后者是评审人名单，调用前先看具体接口页的参数表。
• 候选列表的路径不一致：测试人候选是 GET /pulls/option_testers（不带 PR 编号），评审人候选是 GET /pulls/{number}/option_reviewers。
• 文件变更有两套返回：/pulls/{number}/files 给变更文件列表，/pulls/{number}/files.json 给变更统计与 diff 引用。

接口列表¶

本模块共 45 个接口。