Interface GitHubReviewComment

Represents a review comment on a specific line of a pull request diff.

See

https://docs.github.com/en/rest/pulls/comments#get-a-review-comment-for-a-pull-request

interface GitHubReviewComment {
    body: string;
    commit_id: string;
    created_at: string;
    diff_hunk: string;
    html_url: string;
    id: number;
    in_reply_to_id?: number;
    line?: number;
    path: string;
    position: null | number;
    pull_request_review_id: number;
    side?: "LEFT" | "RIGHT";
    updated_at: string;
    user: GitHubUser;
}

Properties

body commit_id created_at diff_hunk html_url id in_reply_to_id? line? path position pull_request_review_id side? updated_at user

Properties

body

body: string

Comment body text

commit_id

commit_id: string

The commit SHA this comment was placed on

created_at

created_at: string

ISO 8601 timestamp of creation

diff_hunk

diff_hunk: string

The diff hunk this comment refers to

html_url

html_url: string

URL to the comment on GitHub

id

id: number

Unique numeric comment ID

Optionalin_reply_to_id

in_reply_to_id?: number

ID of the parent comment if this is a reply

Optionalline

line?: number

Line number in the file

path

path: string

Path to the file this comment is on

position

position: null | number

Line position in the diff

pull_request_review_id

pull_request_review_id: number

ID of the review this comment belongs to

Optionalside

side?: "LEFT" | "RIGHT"

Side of the diff (LEFT for old file, RIGHT for new file)

updated_at

updated_at: string

ISO 8601 timestamp of last update

user

user: GitHubUser

User who wrote the comment

Settings

Member Visibility

On This Page

Properties