Skip to content

Comments Object

Relationships

Schema relationships 
graph LR
    Comments -->|"pull_request"| PullRequests
    Comments -->|"parent"| Comments

Properties

idstring
required·

The unique identifier for the comment

authorobject

The author of the comment

idstring

The unique identifier for the author

typestring

The type of the author

Possible values:
userbot
usernamestring

The username of the author

bodyobject

The body of the comment

contentstring

The content of the comment

formatstring

The format of the comment body

Possible values:
markdownhtmlplaintext
commitobject

The commit the comment is associated with

idstring

The SHA of the commit

created_atstring · date-time

The date and time when the comment was created

lineinteger

The line number the comment is associated with (for review comments)

parentobject

The parent comment this is a reply to

References: Comments → id
idstring

The unique identifier for the comment

pathstring

The file path the comment is associated with (for review comments)

pull_requestobject

The pull request that the comment belongs to

References: PullRequests → id
idstring

The unique identifier for the pull request

numberinteger

The number of the pull request

remote_dataRecord<string, any>

Raw data returned from the remote API call.

typestring

The type of the comment

Possible values:
conversation_commentreview_comment
updated_atstring · date-time

The date and time when the comment was last updated