GitHub: Pulls schemas
15 GitHub schemas with complete fields and constraints.
← Pulls operations · All schemas
Create a reply for a review comment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pull Request Review Comments are comments on a portion of the Pull Request's diff. |
_links | object | Required within parent | |
_links.html | object | Required within parent | |
_links.html.href | string | Required within parent | Format: uri |
_links.pull_request | object | Required within parent | |
_links.pull_request.href | string | Required within parent | Format: uri |
_links.self | object | Required within parent | |
_links.self.href | string | Required within parent | Format: uri |
author_association | string | Required within parent | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
body | string | Required within parent | The text of the comment. |
body_html | string | Optional | |
body_text | string | Optional | |
commit_id | string | Required within parent | The SHA of the commit to which the comment applies. |
created_at | string | Required within parent | Format: date-time |
diff_hunk | string | Required within parent | The diff of the line that the comment refers to. |
html_url | string | Required within parent | HTML URL for the pull request review comment. Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | The ID of the pull request review comment. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
in_reply_to_id | JSON | Optional | |
in_reply_to_id (anyOf 1) | integer | Alternative | The comment ID to reply to. |
in_reply_to_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
line | JSON | Optional | |
line (anyOf 1) | integer | Alternative | The line of the blob to which the comment applies. The last line of the range for a multi-line comment |
line (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | The node ID of the pull request review comment. |
original_commit_id | string | Required within parent | The SHA of the original commit to which the comment applies. |
original_line | JSON | Optional | |
original_line (anyOf 1) | integer | Alternative | The line of the blob to which the comment applies. The last line of the range for a multi-line comment |
original_line (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_position | JSON | Optional | |
original_position (anyOf 1) | integer | Alternative | The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. |
original_position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_line | JSON | Optional | |
original_start_line (anyOf 1) | JSON | Alternative | |
original_start_line (anyOf 1) (anyOf 1) | integer | Alternative | The first line of the range for a multi-line comment. |
original_start_line (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_line (anyOf 2) | null | Alternative | |
path | string | Required within parent | The relative path of the file to which the comment applies. |
position | JSON | Optional | |
position (anyOf 1) | integer | Alternative | The line index in the diff to which the comment applies. This field is closing down; use `line` instead. |
position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pull_request_review_id | JSON | Required within parent | |
pull_request_review_id (anyOf 1) | JSON | Alternative | |
pull_request_review_id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the pull request review to which the comment belongs. Format: int64 |
pull_request_review_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pull_request_review_id (anyOf 2) | null | Alternative | |
pull_request_url | string | Required within parent | URL for the pull request that the review comment belongs to. Format: uri |
reactions | Model | Optional | Expand Get an issue — response body — reactions |
side | string | Optional | The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment Known values: LEFT, RIGHT Default: RIGHT |
start_line | JSON | Optional | |
start_line (anyOf 1) | JSON | Alternative | |
start_line (anyOf 1) (anyOf 1) | integer | Alternative | The first line of the range for a multi-line comment. |
start_line (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_line (anyOf 2) | null | Alternative | |
start_side | JSON | Optional | |
start_side (anyOf 1) | string | Alternative | The side of the first line of the range for a multi-line comment. Known values: LEFT, RIGHT Default: RIGHT |
start_side (anyOf 2) | null | Alternative | |
subject_type | string | Optional | The level at which the comment is targeted, can be a diff line or a file. Known values: line, file |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | URL for the pull request review comment |
user | Model | Required within parent | Expand Get an issue — response body — user |
Referenced models: Get an issue — response body — user, Get an issue — response body — reactions
Get a pull request stack — response body — pull requests item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a check run — response body — pull requests item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).draft | boolean | Required within parent | |
$ (allOf 2).html_url | string | Required within parent | Format: uri |
$ (allOf 2).merged_at | JSON | Required within parent | |
$ (allOf 2).merged_at (anyOf 1) | string | Alternative | Format: date-time |
$ (allOf 2).merged_at (anyOf 2) | null | Alternative | |
$ (allOf 2).node_id | string | Required within parent | |
$ (allOf 2).state | string | Required within parent | Known values: open, closed |
$ (allOf 2).title | string | Required within parent | |
$ (allOf 2).user | Model | Required within parent | Expand Get an issue — response body — user |
Referenced models: Get an issue — response body — user, Get a check run — response body — pull requests item
Get a pull request — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. |
_links | object | Required within parent | |
_links.comments | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.commits | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.html | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.issue | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.review_comment | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.review_comments | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.self | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.statuses | Model | Required within parent | Expand Get a pull request — response body — links html |
active_lock_reason | JSON | Optional | |
active_lock_reason (anyOf 1) | string | Alternative | |
active_lock_reason (anyOf 2) | null | Alternative | |
additions | JSON | Required within parent | |
additions (anyOf 1) | integer | Alternative | |
additions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
assignees | array | Optional | |
assignees[] | Model | Each item | Expand List users — response body — item |
author_association | string | Required within parent | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
auto_merge | Model | Required within parent | Expand Get a pull request — response body — auto merge |
base | object | Required within parent | |
base.label | string | Required within parent | |
base.ref | string | Required within parent | |
base.repo | Model | Required within parent | Expand List repositories for the authenticated user — response body — item |
base.sha | string | Required within parent | |
base.user | Model | Required within parent | Expand List users — response body — item |
body | JSON | Required within parent | |
body (anyOf 1) | string | Alternative | |
body (anyOf 2) | null | Alternative | |
changed_files | JSON | Required within parent | |
changed_files (anyOf 1) | integer | Alternative | |
changed_files (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
closed_at | JSON | Required within parent | |
closed_at (anyOf 1) | string | Alternative | Format: date-time |
closed_at (anyOf 2) | null | Alternative | |
comments | JSON | Required within parent | |
comments (anyOf 1) | integer | Alternative | |
comments (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
comments_url | string | Required within parent | Format: uri |
commits | JSON | Required within parent | |
commits (anyOf 1) | integer | Alternative | |
commits (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
commits_url | string | Required within parent | Format: uri |
created_at | string | Required within parent | Format: date-time |
deletions | JSON | Required within parent | |
deletions (anyOf 1) | integer | Alternative | |
deletions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
diff_url | string | Required within parent | Format: uri |
draft | boolean | Optional | Indicates whether or not the pull request is a draft. |
head | object | Required within parent | |
head.label | string | Required within parent | |
head.ref | string | Required within parent | |
head.repo | Model | Required within parent | Expand List repositories for the authenticated user — response body — item |
head.sha | string | Required within parent | |
head.user | Model | Required within parent | Expand List users — response body — item |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issue_url | string | Required within parent | Format: uri |
labels | array | Required within parent | |
labels[] | object | Each item | |
labels[].archived_by | JSON | Required within parent | |
labels[].archived_by (anyOf 1) | JSON | Alternative | The user who archived the label, or `null` if it has not been archived. |
labels[].archived_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand List users — response body — item |
labels[].archived_by (anyOf 2) | null | Alternative | |
labels[].color | string | Required within parent | |
labels[].default | boolean | Required within parent | |
labels[].description | JSON | Required within parent | |
labels[].description (anyOf 1) | string | Alternative | |
labels[].description (anyOf 2) | null | Alternative | |
labels[].id | JSON | Required within parent | |
labels[].id (anyOf 1) | integer | Alternative | Format: int64 |
labels[].id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
labels[].name | string | Required within parent | |
labels[].node_id | string | Required within parent | |
labels[].url | string | Required within parent | |
locked | boolean | Required within parent | |
maintainer_can_modify | boolean | Required within parent | Indicates whether maintainers can modify the pull request. |
mergeable | JSON | Required within parent | |
mergeable (anyOf 1) | boolean | Alternative | |
mergeable (anyOf 2) | null | Alternative | |
mergeable_state | string | Required within parent | |
merged | boolean | Required within parent | |
merged_at | JSON | Required within parent | |
merged_at (anyOf 1) | string | Alternative | Format: date-time |
merged_at (anyOf 2) | null | Alternative | |
merged_by | Model | Required within parent | Expand Get an issue — response body — user |
milestone | Model | Required within parent | Expand Get an issue — response body — milestone |
node_id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | Number uniquely identifying the pull request within its repository. |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
patch_url | string | Required within parent | Format: uri |
rebaseable | JSON | Optional | |
rebaseable (anyOf 1) | boolean | Alternative | |
rebaseable (anyOf 2) | null | Alternative | |
requested_reviewers | array | Optional | |
requested_reviewers[] | Model | Each item | Expand List users — response body — item |
requested_teams | array | Optional | |
requested_teams[] | Model | Each item | Expand List security manager teams — response body — item |
review_comment_url | string | Required within parent | |
review_comments | JSON | Required within parent | |
review_comments (anyOf 1) | integer | Alternative | |
review_comments (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
review_comments_url | string | Required within parent | Format: uri |
stack | Model | Optional | Expand Get a pull request — response body — stack |
state | string | Required within parent | State of this Pull Request. Either `open` or `closed`. Known values: open, closed |
statuses_url | string | Required within parent | Format: uri |
title | string | Required within parent | The title of the pull request. |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
user | Model | Required within parent | Expand List users — response body — item |
Referenced models: Get a pull request — response body — auto merge, Get a pull request — response body — links html, Get an issue — response body — milestone, Get an issue — response body — user, Get a pull request — response body — stack, List repositories for the authenticated user — response body — item, List users — response body — item, List security manager teams — response body — item
Get a pull request — response body — auto merge
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | The status of auto merging a pull request. |
$ (anyOf 1).commit_message | string | Required within parent | Commit message for the merge commit. |
$ (anyOf 1).commit_title | string | Required within parent | Title for the merge commit message. |
$ (anyOf 1).enabled_by | Model | Required within parent | Expand List users — response body — item |
$ (anyOf 1).merge_method | string | Required within parent | The merge method to use. Known values: merge, squash, rebase |
$ (anyOf 2) | null | Alternative |
Referenced models: List users — response body — item
Get a pull request — response body — links html
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Hypermedia Link |
href | string | Required within parent |
Get a pull request — response body — stack
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | The stack information associated with a pull request. |
$ (anyOf 1).base | object | Required within parent | |
$ (anyOf 1).base.ref | string | Required within parent | The base ref of the stack this pull request belongs to. |
$ (anyOf 1).base.sha | string | Required within parent | The base SHA of the stack this pull request belongs to. |
$ (anyOf 1).id | JSON | Optional | |
$ (anyOf 1).id (anyOf 1) | integer | Alternative | The ID of the stack that this pull request belongs to. |
$ (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).number | JSON | Optional | |
$ (anyOf 1).number (anyOf 1) | integer | Alternative | The number of the stack that this pull request belongs to. |
$ (anyOf 1).number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).position | JSON | Optional | |
$ (anyOf 1).position (anyOf 1) | integer | Alternative | The one-based position of this pull request within the stack, where 1 is the bottom of the stack. |
$ (anyOf 1).position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).size | JSON | Optional | |
$ (anyOf 1).size (anyOf 1) | integer | Alternative | The total number of pull requests in the stack. |
$ (anyOf 1).size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2) | null | Alternative |
Get a review for a pull request — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pull Request Reviews are reviews on pull requests. |
_links | object | Required within parent | |
_links.html | object | Required within parent | |
_links.html.href | string | Required within parent | |
_links.pull_request | object | Required within parent | |
_links.pull_request.href | string | Required within parent | |
author_association | string | Required within parent | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
body | string | Required within parent | The text of the review. |
body_html | string | Optional | |
body_text | string | Optional | |
commit_id | JSON | Required within parent | |
commit_id (anyOf 1) | string | Alternative | A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. |
commit_id (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the review Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
pull_request_url | string | Required within parent | Format: uri |
state | string | Required within parent | |
submitted_at | string | Optional | Format: date-time |
user | Model | Required within parent | Expand Get an issue — response body — user |
Referenced models: Get an issue — response body — user
Get all requested reviewers for a pull request — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pull Request Review Request |
teams | array | Required within parent | |
teams[] | Model | Each item | Expand List teams — response body — item |
users | array | Required within parent | |
users[] | Model | Each item | Expand List users — response body — item |
Referenced models: List users — response body — item, List teams — response body — item
Get the result of an asynchronous merge — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pull Request Merge Async Result Additional keys: not allowed |
details | JSON | Required within parent | |
details (anyOf 1) | object | Alternative | When the asynchronous merge request is pending Additional keys: not allowed |
details (anyOf 1).bypass_rules | boolean | Optional | Whether the asynchronous merge request will attempt to bypass repository rules that the authenticated actor is permitted to bypass. Default: false |
details (anyOf 1).expected_head_sha | string | Required within parent | SHA that the pull request head must match for the enqueued merge to proceed. |
details (anyOf 1).merge_action | string | Required within parent | Known values: default, merge_queue, direct_merge |
details (anyOf 1).merge_method | string | Required within parent | Known values: default, merge, squash, rebase |
details (anyOf 1).message | string | Required within parent | |
details (anyOf 1).uuid | string | Required within parent | |
details (anyOf 2) | object | Alternative | When the pull request is in a merge queue Additional keys: not allowed |
details (anyOf 2).message | string | Required within parent | |
details (anyOf 3) | object | Alternative | When the asynchronous merge request failed Additional keys: not allowed |
details (anyOf 3).message | string | Required within parent | |
details (anyOf 4) | object | Alternative | When the pull request has been merged Additional keys: not allowed |
details (anyOf 4).message | string | Required within parent | |
details (anyOf 4).sha | string | Required within parent | |
status | string | Required within parent | Known values: pending, merged, enqueued, failed |
List comments for a pull request review — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Legacy Review Comment |
_links | object | Required within parent | |
_links.html | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.pull_request | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.self | Model | Required within parent | Expand Get a pull request — response body — links html |
author_association | string | Required within parent | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
body | string | Required within parent | |
body_html | string | Optional | |
body_text | string | Optional | |
commit_id | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
diff_hunk | string | Required within parent | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
in_reply_to_id | JSON | Optional | |
in_reply_to_id (anyOf 1) | integer | Alternative | |
in_reply_to_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
line | JSON | Optional | |
line (anyOf 1) | integer | Alternative | The line of the blob to which the comment applies. The last line of the range for a multi-line comment |
line (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
original_commit_id | string | Required within parent | |
original_line | JSON | Optional | |
original_line (anyOf 1) | integer | Alternative | The original line of the blob to which the comment applies. The last line of the range for a multi-line comment |
original_line (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_position | JSON | Required within parent | |
original_position (anyOf 1) | integer | Alternative | |
original_position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_line | JSON | Optional | |
original_start_line (anyOf 1) | JSON | Alternative | |
original_start_line (anyOf 1) (anyOf 1) | integer | Alternative | The original first line of the range for a multi-line comment. |
original_start_line (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_start_line (anyOf 2) | null | Alternative | |
path | string | Required within parent | |
position | JSON | Required within parent | |
position (anyOf 1) | JSON | Alternative | |
position (anyOf 1) (anyOf 1) | integer | Alternative | |
position (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
position (anyOf 2) | null | Alternative | |
pull_request_review_id | JSON | Required within parent | |
pull_request_review_id (anyOf 1) | JSON | Alternative | |
pull_request_review_id (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
pull_request_review_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pull_request_review_id (anyOf 2) | null | Alternative | |
pull_request_url | string | Required within parent | Format: uri |
reactions | Model | Optional | Expand Get an issue — response body — reactions |
side | string | Optional | The side of the first line of the range for a multi-line comment. Known values: LEFT, RIGHT Default: RIGHT |
start_line | JSON | Optional | |
start_line (anyOf 1) | JSON | Alternative | |
start_line (anyOf 1) (anyOf 1) | integer | Alternative | The first line of the range for a multi-line comment. |
start_line (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_line (anyOf 2) | null | Alternative | |
start_side | JSON | Optional | |
start_side (anyOf 1) | string | Alternative | The side of the first line of the range for a multi-line comment. Known values: LEFT, RIGHT Default: RIGHT |
start_side (anyOf 2) | null | Alternative | |
subject_type | string | Optional | The level at which the comment is targeted, can be a diff line or a file. Known values: line, file |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
user | Model | Required within parent | Expand Get an issue — response body — user |
Referenced models: Get a pull request — response body — links html, Get an issue — response body — user, Get an issue — response body — reactions
List pull request stacks — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base | object | Required within parent | |
base.ref | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
open | boolean | Required within parent | Whether the stack has any open pull request. False when all pull requests are merged or closed. |
pull_requests | array | Required within parent | |
pull_requests[] | object | Each item | |
pull_requests[].draft | boolean | Required within parent | |
pull_requests[].head | object | Required within parent | |
pull_requests[].head.ref | string | Required within parent | |
pull_requests[].head.sha | string | Required within parent | |
pull_requests[].merged_at | JSON | Required within parent | |
pull_requests[].merged_at (anyOf 1) | string | Alternative | Format: date-time |
pull_requests[].merged_at (anyOf 2) | null | Alternative | |
pull_requests[].number | JSON | Required within parent | |
pull_requests[].number (anyOf 1) | integer | Alternative | |
pull_requests[].number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pull_requests[].state | string | Required within parent | Known values: open, closed |
url | string | Required within parent | Format: uri |
List pull requests files — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Diff Entry |
additions | JSON | Required within parent | |
additions (anyOf 1) | integer | Alternative | |
additions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
blob_url | string | Required within parent | Format: uri |
changes | JSON | Required within parent | |
changes (anyOf 1) | integer | Alternative | |
changes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
contents_url | string | Required within parent | Format: uri |
deletions | JSON | Required within parent | |
deletions (anyOf 1) | integer | Alternative | |
deletions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
filename | string | Required within parent | |
patch | string | Optional | |
previous_filename | string | Optional | |
raw_url | string | Required within parent | Format: uri |
sha | JSON | Required within parent | |
sha (anyOf 1) | string | Alternative | |
sha (anyOf 2) | null | Alternative | |
status | string | Required within parent | Known values: added, removed, modified, renamed, copied, changed, unchanged |
Merge a pull request — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pull Request Merge Result |
merged | boolean | Required within parent | |
message | string | Required within parent | |
sha | string | Required within parent |
Remove pull requests from a pull request stack — response body — base, created at, id, node id, number, open, pull requests, url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base | object | Required within parent | |
base.ref | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
open | boolean | Required within parent | Whether the stack has any open pull request. False when all pull requests are merged or closed. |
pull_requests | array | Required within parent | |
pull_requests[] | Model | Each item | Expand Get a pull request stack — response body — pull requests item |
url | string | Required within parent | Format: uri |
Referenced models: Get a pull request stack — response body — pull requests item
Request reviewers for a pull request — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pull Request Simple |
_links | object | Required within parent | |
_links.comments | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.commits | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.html | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.issue | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.review_comment | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.review_comments | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.self | Model | Required within parent | Expand Get a pull request — response body — links html |
_links.statuses | Model | Required within parent | Expand Get a pull request — response body — links html |
active_lock_reason | JSON | Optional | |
active_lock_reason (anyOf 1) | string | Alternative | |
active_lock_reason (anyOf 2) | null | Alternative | |
assignees | array | Optional | |
assignees[] | Model | Each item | Expand List users — response body — item |
author_association | string | Required within parent | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
auto_merge | Model | Required within parent | Expand Get a pull request — response body — auto merge |
base | object | Required within parent | |
base.label | string | Required within parent | |
base.ref | string | Required within parent | |
base.repo | Model | Required within parent | Expand List repositories for the authenticated user — response body — item |
base.sha | string | Required within parent | |
base.user | Model | Required within parent | Expand Get an issue — response body — user |
body | JSON | Required within parent | |
body (anyOf 1) | string | Alternative | |
body (anyOf 2) | null | Alternative | |
closed_at | JSON | Required within parent | |
closed_at (anyOf 1) | string | Alternative | Format: date-time |
closed_at (anyOf 2) | null | Alternative | |
comments_url | string | Required within parent | Format: uri |
commits_url | string | Required within parent | Format: uri |
created_at | string | Required within parent | Format: date-time |
diff_url | string | Required within parent | Format: uri |
draft | boolean | Optional | Indicates whether or not the pull request is a draft. |
head | object | Required within parent | |
head.label | string | Required within parent | |
head.ref | string | Required within parent | |
head.repo | Model | Required within parent | Expand List repositories for the authenticated user — response body — item |
head.sha | string | Required within parent | |
head.user | Model | Required within parent | Expand Get an issue — response body — user |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
issue_url | string | Required within parent | Format: uri |
labels | array | Required within parent | |
labels[] | object | Each item | |
labels[].archived_by | JSON | Required within parent | |
labels[].archived_by (anyOf 1) | JSON | Alternative | The user who archived the label, or `null` if it has not been archived. |
labels[].archived_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand List users — response body — item |
labels[].archived_by (anyOf 2) | null | Alternative | |
labels[].color | string | Required within parent | |
labels[].default | boolean | Required within parent | |
labels[].description | string | Required within parent | |
labels[].id | JSON | Required within parent | |
labels[].id (anyOf 1) | integer | Alternative | Format: int64 |
labels[].id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
labels[].name | string | Required within parent | |
labels[].node_id | string | Required within parent | |
labels[].url | string | Required within parent | |
locked | boolean | Required within parent | |
merged_at | JSON | Required within parent | |
merged_at (anyOf 1) | string | Alternative | Format: date-time |
merged_at (anyOf 2) | null | Alternative | |
milestone | Model | Required within parent | Expand Get an issue — response body — milestone |
node_id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
patch_url | string | Required within parent | Format: uri |
requested_reviewers | array | Optional | |
requested_reviewers[] | Model | Each item | Expand List users — response body — item |
requested_teams | array | Optional | |
requested_teams[] | Model | Each item | Expand List teams — response body — item |
review_comment_url | string | Required within parent | |
review_comments_url | string | Required within parent | Format: uri |
stack | Model | Optional | Expand Get a pull request — response body — stack |
state | string | Required within parent | |
statuses_url | string | Required within parent | Format: uri |
title | string | Required within parent | |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
user | Model | Required within parent | Expand Get an issue — response body — user |
Referenced models: Get a pull request — response body — auto merge, Get a pull request — response body — links html, Get an issue — response body — milestone, Get an issue — response body — user, Get a pull request — response body — stack, List repositories for the authenticated user — response body — item, List users — response body — item, List teams — response body — item