reviews
Overview
| Name | reviews |
| Type | Resource |
| Id | github.pulls.reviews |
Fields
| Name | Datatype | Description |
|---|---|---|
id | integer | Unique identifier of the review |
commit_id | string | A commit SHA for the review. |
node_id | string | |
body_text | string | |
_links | object | |
author_association | string | How the author is associated with the repository. |
html_url | string | |
user | object | Simple User |
body | string | The text of the review. |
submitted_at | string | |
body_html | string | |
pull_request_url | string | |
state | string |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_review | SELECT | owner, pull_number, repo, review_id | |
list_reviews | SELECT | owner, pull_number, repo | The list of reviews returns in chronological order. |
create_review | INSERT | owner, pull_number, repo | This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary 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. |
delete_pending_review | DELETE | owner, pull_number, repo, review_id | |
dismiss_review | EXEC | owner, pull_number, repo, review_id, data__message | Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. |
submit_review | EXEC | owner, pull_number, repo, review_id, data__event | |
update_review | EXEC | owner, pull_number, repo, review_id, data__body | Update the review summary comment with new text. |