pullrequestcomment.md

PullRequestComment Schema

https://platform.codeclimate.com/schemas/pull-request-comment

A Pull Request Comment is a review comment that's related to a Pull Request.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	PullRequestComment.schema.json

PullRequestComment Type

object (PullRequestComment)

PullRequestComment Properties

Property	Type	Required	Nullable	Defined by
_type	string	Required	cannot be null	PullRequestComment
id	string	Required	cannot be null	PullRequestComment
self	string	Required	cannot be null	PullRequestComment
pullRequest	Merged	Required	cannot be null	PullRequestComment
pullRequestReview	Merged	Optional	cannot be null	PullRequestComment
author	Merged	Required	cannot be null	PullRequestComment
body	string	Optional	cannot be null	PullRequestComment
bodyHtml	string	Optional	cannot be null	PullRequestComment
bodyText	Unknown Type	Optional	can be null	PullRequestComment
state	string	Optional	cannot be null	PullRequestComment
path	string	Optional	cannot be null	PullRequestComment
position	integer	Optional	cannot be null	PullRequestComment
outdated	boolean	Optional	cannot be null	PullRequestComment
publishedAt	string	Optional	cannot be null	PullRequestComment
draftedAt	string	Optional	cannot be null	PullRequestComment
createdAt	string	Optional	cannot be null	PullRequestComment
updatedAt	string	Optional	cannot be null	PullRequestComment

_type

_type

• is required
• Type: string
• cannot be null
• defined in: PullRequestComment

_type Type

string

_type Constraints

constant: the value of this property must be equal to:

"PullRequestComment"

id

The unique ID of this pull request comment

id

• is required
• Type: string
• cannot be null
• defined in: PullRequestComment

id Type

string

self

The canonical URI for this record

self

• is required
• Type: string
• cannot be null
• defined in: PullRequestComment

self Type

string

self Constraints

URI: the string must be a URI, according to RFC 3986

pullRequest

The self URI of the PullRequest, or a nested PullRequest record.

pullRequest

• is required
• Type: merged type (Details)
• cannot be null
• defined in: PullRequestComment

pullRequest Type

merged type (Details)

one (and only one) of

• PullRequest
• Untitled string in PullRequestComment

pullRequestReview

The self URI of the review, or a nested review record.

pullRequestReview

• is optional
• Type: merged type (Details)
• cannot be null
• defined in: PullRequestComment

pullRequestReview Type

merged type (Details)

one (and only one) of

• Review
• Untitled string in PullRequestComment

author

The self URI of the author, or a nested author record.

author

• is required
• Type: merged type (Details)
• cannot be null
• defined in: PullRequestComment

author Type

merged type (Details)

one (and only one) of

• Actor
• Untitled string in PullRequestComment

body

The body of this pull request comment

body

• is optional
• Type: string
• cannot be null
• defined in: PullRequestComment

body Type

string

bodyHtml

The body html of this pull request comment

bodyHtml

• is optional
• Type: string
• cannot be null
• defined in: PullRequestComment

bodyHtml Type

string

bodyText

bodyText

• is optional
• Type: string
• can be null
• defined in: PullRequestComment

bodyText Type

string

state

The state of a pull request comment

state

• is optional
• Type: string
• cannot be null
• defined in: PullRequestComment

state Type

string

path

The path of this pull request comment

path

• is optional
• Type: string
• cannot be null
• defined in: PullRequestComment

path Type

string

position

The position of this pull request comment

position

• is optional
• Type: integer
• cannot be null
• defined in: PullRequestComment

position Type

integer

outdated

Whether the pull request comment is outdated

outdated

• is optional
• Type: boolean
• cannot be null
• defined in: PullRequestComment

outdated Type

boolean

publishedAt

The time pull request comment was published

publishedAt

• is optional
• Type: string
• cannot be null
• defined in: PullRequestComment

publishedAt Type

string

publishedAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

draftedAt

The time pull request comment was drafted

draftedAt

• is optional
• Type: string
• cannot be null
• defined in: PullRequestComment

draftedAt Type

string

draftedAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

createdAt

The time pull request comment was created

createdAt

• is optional
• Type: string
• cannot be null
• defined in: PullRequestComment

createdAt Type

string

createdAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

updatedAt

The time pull request comment was updated

updatedAt

• is optional
• Type: string
• cannot be null
• defined in: PullRequestComment

updatedAt Type

string

updatedAt Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6