Github API - Test Config

POST /repos/{owner}/{repo}/pulls/{pull_number}/comments
repos
pulls

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "Create an issue comment." We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

Note: 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.

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.
Create a review comment for a pull request

Arguments
key owner

owner [scalar]

The account owner of the repository. The name is not case sensitive.

API:
Github Open API
(version: 1.1.4)

key repo

repo [scalar]

The name of the repository. The name is not case sensitive.

API:
Github Open API
(version: 1.1.4)

key pull-number

pull-number [scalar]

The number that identifies the pull request.

API:
Github Open API
(version: 1.1.4)

Returns
201 application/json pull-request-review-comment

pull-request-review-comment [object]

Pull Request Review Comments are comments on a portion of the Pull Request's diff.

Attributes
_links 2089

author_association author-association

body string

The text of the comment.

body_html string

body_text string

commit_id string

The SHA of the commit to which the comment applies.

created_at string

diff_hunk string

The diff of the line that the comment refers to.

html_url string

HTML URL for the pull request review comment.

id 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.

original_commit_id string

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

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. This field is deprecated; use original_line instead.

original_start_line integer

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

path string

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

position integer

The line index in the diff to which the comment applies. This field is deprecated; use line instead.

pull_request_review_id integer

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

pull_request_url string

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

reactions reaction-rollup

side 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

start_line integer

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

start_side string

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

updated_at string

url string

URL for the pull request review comment

API:
Github Open API
(version: 1.1.4)
403 forbidden

forbidden [scalar]

Forbidden

API:
Github Open API
(version: 1.1.4)
422 validation_failed

validation_failed [scalar]

Validation failed, or the endpoint has been spammed.

API:
Github Open API
(version: 1.1.4)
API:
Github Open API
(version: 1.1.4)