reviews
Overview
| Name | reviews |
| Type | Resource |
| Id | github.pulls.reviews |
Fields
| Name | Datatype | Description |
|---|---|---|
id | integer | Unique identifier of the review |
body | string | The text of the review. |
body_text | string | |
user | object | A GitHub user. |
body_html | string | |
submitted_at | string | |
commit_id | string | A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be null. |
html_url | string | |
state | string | |
author_association | string | How the author is associated with the repository. |
_links | object | |
node_id | string | |
pull_request_url | string |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_review | SELECT | owner, pull_number, repo, review_id | Retrieves a pull request review by its 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 are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see "Submit a review for a pull request."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 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 | Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. |
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 | Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "Create a review for a pull request." |
update_review | EXEC | owner, pull_number, repo, review_id, data__body | Update the review summary comment with new text. |