REST API 现在已版本化。 有关更多信息，请参阅“关于 API 版本控制”。

用于拉取请求审查评论的 REST API 端点

使用 REST API 与拉取请求审查评论进行交互。

关于拉取请求审查评论

拉取请求审查评论是在拉取请求审查期间对统一差异的一部分做出的评论。这些评论不同于拉取请求中的提交评论和问题评论。有关更多信息，请参阅“用于提交评论的 REST API 端点”和“用于问题评论的 REST API 端点”。

在存储库中列出审查评论

列出存储库中所有拉取请求的审查评论。默认情况下，审查评论按 ID 升序排列。

此端点支持以下自定义媒体类型。有关更多信息，请参阅“媒体类型”。

  • application/vnd.github-commitcomment.raw+json：返回原始 markdown 正文。响应将包括 body。如果您未传递任何特定媒体类型，则这是默认值。
  • application/vnd.github-commitcomment.text+json：返回 markdown 正文的纯文本表示形式。响应将包括 body_text。
  • application/vnd.github-commitcomment.html+json：返回正文 markdown 呈现的 HTML。响应将包括 body_html。
  • application/vnd.github-commitcomment.full+json：返回原始、文本和 HTML 表示形式。响应将包括 body、body_text 和 body_html。

用于“在存储库中列出审查评论”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “请求合并”存储库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“在存储库中列出审查评论”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

查询参数
sort string

可以是以下之一: created, updated, created_at

direction string

对结果进行排序的方向。如果没有 sort 参数，则忽略。

可以是以下之一: asc, desc

since string

仅显示在给定时间之后最后更新的结果。这是 ISO 8601 格式的时间戳：YYYY-MM-DDTHH:MM:SSZ。

per_page integer

每页的结果数（最大 100）。有关更多信息，请参阅“在 REST API 中使用分页”。

默认: 30

page integer

要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。

默认: 1

“列出存储库中的审阅评论”的 HTTP 响应状态代码

状态代码说明
200

OK

“列出存储库中的审阅评论”的代码示例

请求示例

get/repos/{owner}/{repo}/pulls/comments
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/pulls/comments

响应

状态：200
[ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } ]

获取拉取请求的审阅评论

提供指定审阅评论的详细信息。

此端点支持以下自定义媒体类型。有关更多信息，请参阅“媒体类型”。

  • application/vnd.github-commitcomment.raw+json：返回原始 markdown 正文。响应将包括 body。如果您未传递任何特定媒体类型，则这是默认值。
  • application/vnd.github-commitcomment.text+json：返回 markdown 正文的纯文本表示形式。响应将包括 body_text。
  • application/vnd.github-commitcomment.html+json：返回正文 markdown 呈现的 HTML。响应将包括 body_html。
  • application/vnd.github-commitcomment.full+json：返回原始、文本和 HTML 表示形式。响应将包括 body、body_text 和 body_html。

“获取拉取请求的审阅评论”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “请求合并”存储库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“获取拉取请求的审核评论”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

comment_id 整数 必需

评论的唯一标识符。

“获取拉取请求的审核评论”的 HTTP 响应状态代码

状态代码说明
200

OK

404

资源未找到

“获取拉取请求的审核评论”的代码示例

请求示例

get/repos/{owner}/{repo}/pulls/comments/{comment_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/pulls/comments/COMMENT_ID

响应

状态：200
{ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" }

更新拉取请求的审核评论

编辑指定审核评论的内容。

此端点支持以下自定义媒体类型。有关更多信息，请参阅“媒体类型”。

  • application/vnd.github-commitcomment.raw+json：返回原始 markdown 正文。响应将包括 body。如果您未传递任何特定媒体类型，则这是默认值。
  • application/vnd.github-commitcomment.text+json：返回 markdown 正文的纯文本表示形式。响应将包括 body_text。
  • application/vnd.github-commitcomment.html+json：返回正文 markdown 呈现的 HTML。响应将包括 body_html。
  • application/vnd.github-commitcomment.full+json：返回原始、文本和 HTML 表示形式。响应将包括 body、body_text 和 body_html。

“更新拉取请求的审阅评论”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “拉取请求”存储库权限（写入）

“更新拉取请求的审阅评论”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

comment_id 整数 必需

评论的唯一标识符。

正文参数
body 字符串 必需

对审阅评论的回复文本。

“更新拉取请求的审阅评论”的 HTTP 响应状态代码

状态代码说明
200

OK

“更新拉取请求的审阅评论”的代码示例

请求示例

patch/repos/{owner}/{repo}/pulls/comments/{comment_id}
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/pulls/comments/COMMENT_ID \ -d '{"body":"我也喜欢这个！"}'

响应

状态：200
{ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" }

删除拉取请求的审阅评论

删除审阅评论。

“删除拉取请求的审阅评论”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “拉取请求”存储库权限（写入）

“删除拉取请求的审阅评论”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

comment_id 整数 必需

评论的唯一标识符。

“删除拉取请求的审阅评论”的 HTTP 响应状态代码

状态代码说明
204

无内容

404

资源未找到

“删除拉取请求的审阅评论”的代码示例

请求示例

delete/repos/{owner}/{repo}/pulls/comments/{comment_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/pulls/comments/COMMENT_ID

响应

状态：204

列出拉取请求的审阅评论

列出指定拉取请求的所有审阅评论。默认情况下，审阅评论按 ID 升序排列。

此端点支持以下自定义媒体类型。有关更多信息，请参阅“媒体类型”。

  • application/vnd.github-commitcomment.raw+json：返回原始 markdown 正文。响应将包括 body。如果您未传递任何特定媒体类型，则这是默认值。
  • application/vnd.github-commitcomment.text+json：返回 markdown 正文的纯文本表示形式。响应将包括 body_text。
  • application/vnd.github-commitcomment.html+json：返回正文 markdown 呈现的 HTML。响应将包括 body_html。
  • application/vnd.github-commitcomment.full+json：返回原始、文本和 HTML 表示形式。响应将包括 body、body_text 和 body_html。

“列出拉取请求的审阅评论”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “请求合并”存储库权限（读取）

如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出拉取请求的审阅评论”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

pull_number 整数 必需

标识拉取请求的数字。

查询参数
sort string

用于对结果进行排序的属性。

默认: created

可以为: created, updated

direction string

对结果进行排序的方向。如果没有 sort 参数，则忽略。

可以是以下之一: asc, desc

since string

仅显示在给定时间之后最后更新的结果。这是 ISO 8601 格式的时间戳：YYYY-MM-DDTHH:MM:SSZ。

per_page integer

每页的结果数（最大 100）。有关更多信息，请参阅“在 REST API 中使用分页”。

默认: 30

page integer

要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。

默认: 1

“列出拉取请求的审核评论”的 HTTP 响应状态代码

状态代码说明
200

OK

“列出拉取请求的审核评论”的代码示例

请求示例

get/repos/{owner}/{repo}/pulls/{pull_number}/comments
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/comments

响应

状态：200
[ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } ]

为拉取请求创建审核评论

在指定拉取请求的 diff 中创建审核评论。若要向拉取请求时间线添加常规评论，请参阅“创建问题评论”。

如果您的评论适用于拉取请求 diff 中的多个行，您应在请求中使用参数 line、side，以及可选参数 start_line 和 start_side。

position 参数已弃用。如果您使用 position，则不需要 line、side、start_line 和 start_side 参数。

此端点触发通知。使用此端点过快创建内容可能会导致次要速率限制。有关更多信息，请参阅“REST API 的速率限制”和“使用 REST API 的最佳实践”。

此端点支持以下自定义媒体类型。有关更多信息，请参阅“媒体类型”。

  • application/vnd.github-commitcomment.raw+json：返回原始 markdown 正文。响应将包括 body。如果您未传递任何特定媒体类型，则这是默认值。
  • application/vnd.github-commitcomment.text+json：返回 markdown 正文的纯文本表示形式。响应将包括 body_text。
  • application/vnd.github-commitcomment.html+json：返回正文 markdown 呈现的 HTML。响应将包括 body_html。
  • application/vnd.github-commitcomment.full+json：返回原始、文本和 HTML 表示形式。响应将包括 body、body_text 和 body_html。

“为拉取请求创建审核评论”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “拉取请求”存储库权限（写入）

“为拉取请求创建审核评论”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

pull_number 整数 必需

标识拉取请求的数字。

正文参数
body 字符串 必需

审核评论的文本。

commit_id string Required

需要评论的提交的 SHA。如果不使用最新的提交 SHA，则如果后续提交修改您指定为 position 的行，您的评论可能会过时。

path string Required

需要评论的文件的相对路径。

position integer

此参数已弃用。请改用 line。要在其中添加审阅评论的 diff 中的位置。请注意，此值与文件中的行号不同。位置值等于要添加评论的文件中从第一个“@@”hunk 头开始向下换行的行数。位于“@@”行正下方的行是第 1 行，下一行是第 2 行，依此类推。diff 中的位置将持续增加，直到新文件的开头，期间会经过空白行和附加 hunk。

side 字符串

在拆分 diff 视图中，拉取请求的更改出现在 diff 的哪一侧。可以是 LEFT 或 RIGHT。对于以红色显示的删除，请使用 LEFT。对于以绿色显示的添加或以白色显示且作为上下文显示的未更改行，请使用 RIGHT。对于多行评论，side 表示评论范围的最后一行是删除还是添加。有关更多信息，请参阅 GitHub 帮助文档中的“Diff 视图选项”。

可以为以下之一: LEFT, RIGHT

line 整数

除非使用 subject_type:file，否则必需。评论适用的拉取请求 diff 中的 blob 行。对于多行评论，评论适用的范围的最后一行。

start_line 整数

除非使用 in_reply_to，否则在使用多行评论时必需。start_line 是多行评论适用的拉取请求 diff 中的第一行。要详细了解多行评论，请参阅 GitHub 帮助文档中的“对拉取请求进行评论”。

start_side 字符串

除非使用 in_reply_to，否则在使用多行评论时必需。start_side 是评论适用的 diff 的起始侧。可以是 LEFT 或 RIGHT。要详细了解多行评论，请参阅 GitHub 帮助文档中的“对拉取请求进行评论”。有关其他上下文，请参阅此表中的 side。

可以为以下之一: LEFT, RIGHT, side

in_reply_to 整数

要回复的评论的 ID。要查找具有 “列出拉取请求上的评论” 的评论的 ID。指定后，将忽略请求正文中除 body 之外的所有参数。

subject_type string

评论针对的级别。

可以是其中之一： line, file

“为拉取请求创建评论”的 HTTP 响应状态代码

状态代码说明
201

已创建

403

禁止

422

验证失败，或端点已被标记为垃圾邮件。

“为拉取请求创建评论”的代码示例

请求示例

post/repos/{owner}/{repo}/pulls/{pull_number}/comments
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/comments \ -d '{"body":"Great stuff!","commit_id":"6dcb09b5b57875f334f61aebed695e2e4193db5e","path":"file1.txt","start_line":1,"start_side":"RIGHT","line":2,"side":"RIGHT"}'

响应

状态：201
{ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" }

创建评论的回复

为拉取请求的评论创建回复。对于 comment_id，提供要回复的评论的 ID。这必须是顶级评论的 ID，而不是对该评论的回复。不支持回复回复。

此端点触发通知。使用此端点过快创建内容可能会导致次要速率限制。有关更多信息，请参阅“REST API 的速率限制”和“使用 REST API 的最佳实践”。

此端点支持以下自定义媒体类型。有关更多信息，请参阅“媒体类型”。

  • application/vnd.github-commitcomment.raw+json：返回原始 markdown 正文。响应将包括 body。如果您未传递任何特定媒体类型，则这是默认值。
  • application/vnd.github-commitcomment.text+json：返回 markdown 正文的纯文本表示形式。响应将包括 body_text。
  • application/vnd.github-commitcomment.html+json：返回正文 markdown 呈现的 HTML。响应将包括 body_html。
  • application/vnd.github-commitcomment.full+json：返回原始、文本和 HTML 表示形式。响应将包括 body、body_text 和 body_html。

“创建评论的回复”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “拉取请求”存储库权限（写入）

“创建评论的回复”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
owner string 必需

存储库的帐户所有者。名称不区分大小写。

repo string 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

pull_number 整数 必需

标识拉取请求的数字。

comment_id 整数 必需

评论的唯一标识符。

正文参数
body 字符串 必需

审核评论的文本。

“创建评论的回复”的 HTTP 响应状态代码

状态代码说明
201

已创建

404

资源未找到

“创建评论的回复”的代码示例

请求示例

post/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/pulls/PULL_NUMBER/comments/COMMENT_ID/replies \ -d '{"body":"Great stuff!"}'

响应

状态：201
{ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 426899381, "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "body": "好东西！", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" }