Skip to content

Relationships

Schema relationships
graph LR
    Reviews -->|"pull_request"| PullRequests

Properties

idstring
required·

The unique identifier for the review

authorobject

The author of the review

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 review

contentstring

The content of the review body

formatstring

The format of the body

Possible values:
markdownhtmlplaintext
commitobject

The commit that was reviewed

idstring

The SHA of the commit

urlstring

The URL to view the commit in the browser

created_atstring · date-time

The date and time when the review was created

pull_requestobject

The pull request this review belongs to

idstring

The unique identifier of the pull request

numberinteger

The number of the pull request

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the review

Possible values:
approvedsuggested_changescommenteddismissedpending
submitted_atstring · date-time

The date and time when the review was submitted

updated_atstring · date-time

The date and time when the review was last updated

urlsobject[]

URLs associated with the review

typestring

The type of the URL

Possible values:
reviewpull_request
urlstring

The URL