List review comments on a pull request

Lists all review comments for a pull request. By default, review comments are in ascending order by ID.

[ { "_links": { "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" }, "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" } }, "author_association": "OWNER", "body": "We should probably include a check for null values here.", "body_html": "\"<p>comment body</p>\"", "body_text": "\"comment body\"", "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "created_at": "2011-04-14T16:00:49Z", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "id": 1, "in_reply_to_id": 8, "line": 2, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "original_line": 2, "original_position": 4, "original_start_line": 2, "path": "config/database.yaml", "position": 1, "pull_request_review_id": 42, "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "reactions": { "+1": 0, "-1": 0, "confused": 0, "eyes": 0, "heart": 0, "hooray": 0, "laugh": 0, "rocket": 0, "total_count": 0, "url": "http://example.com" }, "side": "RIGHT", "start_line": 2, "start_side": "RIGHT", "updated_at": "2011-04-14T16:00:49Z", "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "user": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "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}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" } } ]

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

pull_number

integer

必需

Query 参数

sort

string

可选

One of created (when the repository was starred) or updated (when it was last pushed to).

direction

string

可选

Can be either asc or desc. Ignored without sort parameter.

since

string

可选

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

per_page

integer

可选

Results per page (max 100).

page

integer

可选

Page number of the results to fetch.

返回响应

🟢200Response

application/json

Body

array of:

_links

object

必需

html

object

必需

pull_request

object

必需

self

object

必需

author_association

enum<string>

必需

How the author is associated with the repository.

枚举值:

COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

示例值:

OWNER

body

string

必需

The text of the comment.

示例值:

We should probably include a check for null values here.

body_html

string

可选

示例值:

"<p>comment body</p>"

body_text

string

可选

示例值:

"comment body"

commit_id

string

必需

The SHA of the commit to which the comment applies.

示例值:

6dcb09b5b57875f334f61aebed695e2e4193db5e

created_at

string <date-time>

必需

示例值:

2011-04-14T16:00:49Z

diff_hunk

string

必需

The diff of the line that the comment refers to.

示例值:

@@ -16,33 +16,40 @@ public class Connection : IConnection...

html_url

string <uri>

必需

HTML URL for the pull request review comment.

示例值:

https://github.com/octocat/Hello-World/pull/1#discussion-diff-1

integer

必需

The ID of the pull request review comment.

示例值:

in_reply_to_id

integer

可选

The comment ID to reply to.

示例值:

line

integer

可选

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

示例值:

node_id

string

必需

The node ID of the pull request review comment.

示例值:

MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw

original_commit_id

string

必需

The SHA of the original commit to which the comment applies.

示例值:

9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840

original_line

integer

可选

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

示例值:

original_position

integer

必需

The index of the original line in the diff to which the comment applies.

示例值:

original_start_line

integer | null

可选

The first line of the range for a multi-line comment.

示例值:

path

string

必需

The relative path of the file to which the comment applies.

示例值:

config/database.yaml

position

integer

必需

The line index in the diff to which the comment applies.

示例值:

pull_request_review_id

integer | null

必需

The ID of the pull request review to which the comment belongs.

示例值:

pull_request_url

string <uri>

必需

URL for the pull request that the review comment belongs to.

示例值:

https://api.github.com/repos/octocat/Hello-World/pulls/1

reactions

object (Reaction Rollup)

可选

integer

必需

-1

integer

必需

confused

integer

必需

eyes

integer

必需

heart

integer

必需

hooray

integer

必需

laugh

integer

必需

rocket

integer

必需

total_count

integer

必需

url

string <uri>

必需

side

enum<string>

可选

The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment

枚举值:

LEFTRIGHT

默认值:

RIGHT

start_line

integer | null

可选

The first line of the range for a multi-line comment.

示例值:

start_side

enum<string> | enum<null>

可选

The side of the first line of the range for a multi-line comment.

枚举值:

LEFTRIGHT

默认值:

RIGHT

updated_at

string <date-time>

必需

示例值:

2011-04-14T16:00:49Z

url

string

必需

URL for the pull request review comment

示例值:

https://api.github.com/repos/octocat/Hello-World/pulls/comments/1

user

object (Simple User) | null

必需

Simple User

avatar_url

string <uri>

必需

示例值:

https://github.com/images/error/octocat_happy.gif

events_url

string

必需

示例值:

https://api.github.com/users/octocat/events{/privacy}

followers_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/followers

following_url

string

必需

示例值:

https://api.github.com/users/octocat/following{/other_user}

gists_url

string

必需

示例值:

https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id

string | null

必需

示例值:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

必需

示例值:

https://github.com/octocat

integer

必需

示例值:

string

必需

示例值:

octocat

node_id

string

必需

示例值:

MDQ6VXNlcjE=

organizations_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/orgs

received_events_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/received_events

repos_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/repos

site_admin

boolean

必需

starred_at

string

可选

示例值:

"2020-07-09T00:17:55Z"

starred_url

string

必需

示例值:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/subscriptions

type

string

必需

示例值:

User

url

string <uri>

必需

示例值:

https://api.github.com/users/octocat