Skip to content

Latest commit

 

History

History
324 lines (190 loc) · 10.6 KB

pullrequest.md

File metadata and controls

324 lines (190 loc) · 10.6 KB

PullRequest Schema

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

A Pull Request consists of a set of commits.

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

PullRequest Type

object (PullRequest)

PullRequest Properties

Property Type Required Nullable Defined by
_type string Required cannot be null PullRequest
id string Required cannot be null PullRequest
self string Required cannot be null PullRequest
repository Merged Required cannot be null PullRequest
author Merged Required cannot be null PullRequest
state Not specified Required cannot be null PullRequest
headRef string Optional cannot be null PullRequest
headSha string Optional cannot be null PullRequest
baseRef string Optional cannot be null PullRequest
baseSha string Optional cannot be null PullRequest
htmlUrl string Optional cannot be null PullRequest
statistics object Optional cannot be null PullRequest
mergedAt string Optional cannot be null PullRequest
createdAt string Optional cannot be null PullRequest
updatedAt string Optional cannot be null PullRequest

_type

_type

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

_type Type

string

_type Constraints

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

"PullRequest"

id

The unique ID of this pull request.

id

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

id Type

string

self

The canonical URI for this record.

self

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

self Type

string

self Constraints

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

repository

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

repository

repository Type

merged type (Details)

one (and only one) of

author

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

author

author Type

merged type (Details)

one (and only one) of

state

The state of a pull request.

state

  • is required
  • Type: unknown
  • cannot be null
  • defined in: PullRequest

state Type

unknown

state Constraints

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

Value Explanation
"open"
"closed"
"merged"

headRef

The head ref associated with a pull request.

headRef

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

headRef Type

string

headSha

The head sha associated with a pull request.

headSha

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

headSha Type

string

baseRef

The base ref associated with a pull request.

baseRef

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

baseRef Type

string

baseSha

The base sha associated with a pull request.

baseSha

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

baseSha Type

string

htmlUrl

The URL to view this pull request.

htmlUrl

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

htmlUrl Type

string

htmlUrl Constraints

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

statistics

pull request statistics.

statistics

statistics Type

object (Details)

mergedAt

The time the pull request was merged.

mergedAt

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

mergedAt Type

string

mergedAt Constraints

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

createdAt

The time the pull request was created.

createdAt

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

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 the pull request was updated.

updatedAt

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

updatedAt Type

string

updatedAt Constraints

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