Skip to content

Comments Object ​



id
string
REQUIRED · 

The unique identifier for the comment

pull_request
object

The pull request that the comment belongs to

References: PullRequests → id
id
string

The unique identifier for the pull request

number
integer

The number of the pull request

body
object

The body of the comment

content
string

The content of the comment

format
string

The format of the comment body

All possible enum values:
  • markdown
  • html
  • plaintext
author
object

The author of the comment

id
string

The unique identifier for the author

username
string

The username of the author

type
string

The type of the author

All possible enum values:
  • user
  • bot
type
string

The type of the comment

All possible enum values:
  • conversation_comment
  • review_comment
parent
object

The parent comment this is a reply to

References: Comments → id
id
string

The unique identifier for the comment

path
string

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

line
integer

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

commit
object

The commit the comment is associated with

id
string

The SHA of the commit

created_at
string · date-time

The date and time when the comment was created

updated_at
string · date-time

The date and time when the comment was last updated

remote_data
object

Raw data returned from the remote API call.