Skip to main content
Manja / GitHub
Schema1.1.4object

pull-request

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.

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Pull Request

object

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
active_lock_reason string
optionalnullable

Example:too heated

additions integer
required

Example:100

assignees array
optionalnullable
author_association
string<author_association>
required

How the author is associated with the repository.

Example:OWNER

Allowed: "COLLABORATOR""CONTRIBUTOR""FIRST_TIMER""FIRST_TIME_CONTRIBUTOR""MANNEQUIN""MEMBER""NONE""OWNER"

base object
required
body string
requirednullable

Example:Please pull these awesome changes

changed_files integer
required

Example:5

closed_at string (date-time)
requirednullable

Example:2011-01-26T19:01:12Z

comments integer
required

Example:10

comments_url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/issues/1347/comments

commits integer
required

Example:3

commits_url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits

created_at string (date-time)
required

Example:2011-01-26T19:01:12Z

deletions integer
required

Example:3

diff_url string (uri)
required

Example:https://github.com/octocat/Hello-World/pull/1347.diff

draft boolean
optional

Indicates whether or not the pull request is a draft.

Example:false

head object
required
html_url string (uri)
required

Example:https://github.com/octocat/Hello-World/pull/1347

id integer
required

Example:1

issue_url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/issues/1347

labels array
required
locked boolean
required

Example:true

maintainer_can_modify boolean
required

Indicates whether maintainers can modify the pull request.

Example:true

merge_commit_sha string
requirednullable

Example:e5bd3914e2e596debea16f433f57875b5b90bcd6

mergeable boolean
requirednullable

Example:true

mergeable_state string
required

Example:clean

merged boolean
required
merged_at string (date-time)
requirednullable

Example:2011-01-26T19:01:12Z

milestone Milestone object
requirednullable

A collection of related issues and pull requests.

node_id string
required

Example:MDExOlB1bGxSZXF1ZXN0MQ==

number integer
required

Number uniquely identifying the pull request within its repository.

Example:42

patch_url string (uri)
required

Example:https://github.com/octocat/Hello-World/pull/1347.patch

rebaseable boolean
optionalnullable

Example:true

requested_reviewers array
optionalnullable
requested_teams array
optionalnullable
review_comment_url string
required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}

review_comments integer
required

Example:0

review_comments_url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments

state string
required

State of this Pull Request. Either `open` or `closed`.

Example:open

Allowed: "open""closed"

statuses_url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e

title string
required

The title of the pull request.

Example:Amazing new feature

updated_at string (date-time)
required

Example:2011-01-26T19:01:12Z

url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/1347