Skip to content

Latest commit

 

History

History
269 lines (158 loc) · 8.47 KB

pullrequestcomment-properties-pullrequestreview-oneof-review.md

File metadata and controls

269 lines (158 loc) · 8.47 KB

Review Schema

https://platform.codeclimate.com/schemas/review#/properties/pullRequestReview/oneOf/0

A review of a PullRequest.

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*

0 Type

object (Review)

Review Properties

Property Type Required Nullable Defined by
_type string Required cannot be null Review
id string Required cannot be null Review
self string Required cannot be null Review
pullRequest Merged Required cannot be null Review
author Merged Required cannot be null Review
state string Required cannot be null Review
body string Optional cannot be null Review
bodyHtml string Optional cannot be null Review
bodyText string Optional cannot be null Review
publishedAt string Optional cannot be null Review
createdAt string Optional cannot be null Review
updatedAt string Optional cannot be null Review

_type

_type

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

_type Type

string

_type Constraints

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

"Review"

id

The unique ID of this review

id

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

id Type

string

self

The canonical URI for this record

self

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

self Type

string

self Constraints

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

pullRequest

The self URI of the pull request, or a nested pull request record.

pullRequest

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

pullRequest Type

merged type (Details)

one (and only one) of

author

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

author

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

author Type

merged type (Details)

one (and only one) of

state

The state of the review

state

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

state Type

string

state Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"APPROVED"
"COMMENTED"
"DISMISSED"

body

The body of this review

body

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

body Type

string

bodyHtml

The body html of this review

bodyHtml

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

bodyHtml Type

string

bodyText

The body text of this review

bodyText

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

bodyText Type

string

publishedAt

The time this review was published

publishedAt

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

publishedAt Type

string

publishedAt Constraints

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

createdAt

The time this review was created

createdAt

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

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 this review was updated

updatedAt

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

updatedAt Type

string

updatedAt Constraints

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