REST API 现在已版本化。 有关更多信息，请参阅 "关于 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扩展名的仓库名称。名称不区分大小写。

查询参数
per_page 整数

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

默认: 30

page 整数

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

默认: 1

“列出仓库的提交评论”的 HTTP 响应状态码

状态码描述
200

OK

“列出仓库的提交评论”的代码示例

请求示例

get/repos/{owner}/{repo}/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/comments

响应

状态：200
[ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "很棒的东西", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "author_association": "COLLABORATOR" } ]

获取提交评论

获取指定的提交评论。

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

  • 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}/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/comments/COMMENT_ID

响应

状态：200
{ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "很棒的东西", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "author_association": "COLLABORATOR", "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z" }

更新提交评论

更新指定提交评论的内容。

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

  • 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

404

资源未找到

用于“更新提交评论”的代码示例

请求示例

补丁/repos/{owner}/{repo}/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/comments/COMMENT_ID \ -d '{"body":"不错的更改"}'

响应

状态：200
{ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "不错的更改", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "author_association": "COLLABORATOR", "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z" }

删除提交评论

“删除提交评论”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用

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

  • “内容”存储库权限（写入）

“删除提交评论”的参数

标题
accept string

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

路径参数
owner string 必需

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

repo string 必需

不包含.git扩展名的仓库名称。名称不区分大小写。

comment_id 整数 必需

评论的唯一标识符。

“删除提交评论”的 HTTP 响应状态码

状态码描述
204

无内容

404

资源未找到

“删除提交评论”的代码示例

请求示例

delete/repos/{owner}/{repo}/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/comments/COMMENT_ID

响应

状态：204

列出提交评论

列出指定提交的评论。

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

  • 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扩展名的仓库名称。名称不区分大小写。

commit_sha 字符串 必需

提交的 SHA。

查询参数
per_page 整数

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

默认: 30

page 整数

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

默认: 1

“列出提交评论”的 HTTP 响应状态码

状态码描述
200

OK

“列出提交评论”的代码示例

请求示例

get/repos/{owner}/{repo}/commits/{commit_sha}/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/commits/COMMIT_SHA/comments

响应

状态：200
[ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "很棒的东西", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "author_association": "COLLABORATOR" } ]

创建提交评论

使用提交的 :commit_sha 为提交创建评论。

此端点会触发 通知。使用此端点过快地创建内容可能会导致二级速率限制。有关更多信息，请参阅“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扩展名的仓库名称。名称不区分大小写。

commit_sha 字符串 必需

提交的 SHA。

正文参数
body 字符串 必需

评论的内容。

path 字符串

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

position 整数

要评论的 diff 中的行索引。

line 整数

已弃用。请改用 position 参数。要评论的文件中的行号。

“创建提交评论”的 HTTP 响应状态码

状态码描述
201

已创建

403

禁止

422

验证失败，或端点已被垃圾邮件攻击。

“创建提交评论”的代码示例

请求示例

post/repos/{owner}/{repo}/commits/{commit_sha}/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/commits/COMMIT_SHA/comments \ -d '{"body":"Great stuff","path":"file1.txt","position":4,"line":1}'

响应

状态：201
{ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "很棒的东西", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "author_association": "COLLABORATOR", "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z" }