Create a review for a pull request

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

curl --location --request POST 'https://api.github.com/repos///pulls//reviews' \ --header 'Content-Type: application/json' \ --data-raw '{ "body": "This is close to perfect! Please address the suggested inline change.", "comments": [ { "body": "Please add more information here, and fix this typo.", "path": "file.md", "position": 6 } ], "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "event": "REQUEST_CHANGES" }'

{ "_links": { "html": { "href": "string" }, "pull_request": { "href": "string" } }, "author_association": "OWNER", "body": "This looks great.", "body_html": "string", "body_text": "string", "commit_id": "54bb654c9e6025347f57900a4a5c2313a96b8035", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "id": 42, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "state": "CHANGES_REQUESTED", "submitted_at": "2019-08-24T14:15:22Z", "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

必需

Body 参数application/json

body

string

可选

Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

comments

array [object {7}]

可选

Use the following table to specify the location, destination, and contents of the draft review comment.

body

string

必需

Text of the review comment.

line

integer

可选

示例值:

path

string

必需

The relative path to the file that necessitates a review comment.

position

integer

可选

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

side

string

可选

示例值:

RIGHT

start_line

integer

可选

示例值:

start_side

string

可选

示例值:

LEFT

commit_id

string

可选

The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

event

enum<string>

可选

The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

枚举值:

APPROVEREQUEST_CHANGESCOMMENT

示例

返回响应

🟢200Response

application/json

Body

Pull Request Reviews are reviews on pull requests.

_links

object

必需

html

object

必需

pull_request

object

必需

author_association

enum<string>

必需

How the author is associated with the repository.

枚举值:

COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

示例值:

OWNER

body

string

必需

The text of the review.

示例值:

This looks great.

body_html

string

可选

body_text

string

可选

commit_id

string

必需

A commit SHA for the review.

示例值:

54bb654c9e6025347f57900a4a5c2313a96b8035

html_url

string <uri>

必需

示例值:

https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80

integer

必需

Unique identifier of the review

示例值:

node_id

string

必需

示例值:

MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=

pull_request_url

string <uri>

必需

示例值:

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

state

string

必需

示例值:

CHANGES_REQUESTED

submitted_at

string <date-time>

可选

user

null

必需

Simple User

🟠403403

🟠422422