# pull-request

From **GitHub v3 REST API**.

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.

- Type: `object`

## Properties

### `_links`

- Required: true
- Type: `object`

### `active_lock_reason`

- Required: false
- Type: `string`
- Nullable: true
- Example: `too heated`

### `additions`

- Required: true
- Type: `integer`
- Example: `100`

### `assignee`

- Required: true
- Type: `object`
- Nullable: true

Simple User

### `assignees`

- Required: false
- Type: `array`
- Nullable: true

### `author_association`

- Required: true
- Type: `string`
- Example: `OWNER`
- Allowed values: `"COLLABORATOR"`, `"CONTRIBUTOR"`, `"FIRST_TIMER"`, `"FIRST_TIME_CONTRIBUTOR"`, `"MANNEQUIN"`, `"MEMBER"`, `"NONE"`, `"OWNER"`

How the author is associated with the repository.

### `base`

- Required: true
- Type: `object`

### `body`

- Required: true
- Type: `string`
- Nullable: true
- Example: `Please pull these awesome changes`

### `changed_files`

- Required: true
- Type: `integer`
- Example: `5`

### `closed_at`

- Required: true
- Type: `string`
- Format: `date-time`
- Nullable: true
- Example: `2011-01-26T19:01:12Z`

### `comments`

- Required: true
- Type: `integer`
- Example: `10`

### `comments_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://api.github.com/repos/octocat/Hello-World/issues/1347/comments`

### `commits`

- Required: true
- Type: `integer`
- Example: `3`

### `commits_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits`

### `created_at`

- Required: true
- Type: `string`
- Format: `date-time`
- Example: `2011-01-26T19:01:12Z`

### `deletions`

- Required: true
- Type: `integer`
- Example: `3`

### `diff_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://github.com/octocat/Hello-World/pull/1347.diff`

### `draft`

- Required: false
- Type: `boolean`
- Example: `false`

Indicates whether or not the pull request is a draft.

### `head`

- Required: true
- Type: `object`

## JSON Schema

```json
{"description":"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.","properties":{"_links":{"properties":{"comments":{"$ref":"#/components/schemas/link"},"commits":{"$ref":"#/components/schemas/link"},"html":{"$ref":"#/components/schemas/link"},"issue":{"$ref":"#/components/schemas/link"},"review_comment":{"$ref":"#/components/schemas/link"},"review_comments":{"$ref":"#/components/schemas/link"},"self":{"$ref":"#/components/schemas/link"},"statuses":{"$ref":"#/components/schemas/link"}},"required":["comments","commits","statuses","html","issue","review_comments","review_comment","self"],"type":"object"},"active_lock_reason":{"example":"too heated","nullable":true,"type":"string"},"additions":{"example":100,"type":"integer"},"assignee":{"$ref":"#/components/schemas/nullable-simple-user"},"assignees":{"items":{"$ref":"#/components/schemas/simple-user"},"nullable":true,"type":"array"},"author_association":{"$ref":"#/components/schemas/author_association"},"base":{"properties":{"label":{"type":"string"},"ref":{"type":"string"},"repo":{"properties":{"allow_forking":{"type":"boolean"},"allow_merge_commit":{"type":"boolean"},"allow_rebase_merge":{"type":"boolean"},"allow_squash_merge":{"type":"boolean"},"archive_url":{"type":"string"},"archived":{"type":"boolean"},"assignees_url":{"type":"string"},"blobs_url":{"type":"string"},"branches_url":{"type":"string"},"clone_url":{"type":"string"},"collaborators_url":{"type":"string"},"comments_url":{"type":"string"},"commits_url":{"type":"string"},"compare_url":{"type":"string"},"contents_url":{"type":"string"},"contributors_url":{"format":"uri","type":"string"},"created_at":{"format":"date-time","type":"string"},"default_branch":{"type":"string"},"deployments_url":{"format":"uri","type":"string"},"description":{"nullable":true,"type":"string"},"disabled":{"type":"boolean"},"downloads_url":{"format":"uri","type":"string"},"events_url":{"format":"uri","type":"string"},"fork":{"type":"boolean"},"forks":{"type":"integer"},"forks_count":{"type":"integer"},"forks_url":{"format":"uri","type":"string"},"full_name":{"type":"string"},"git_commits_url":{"type":"string"},"git_refs_url":{"type":"string"},"git_tags_url":{"type":"string"},"git_url":{"type":"string"},"has_downloads":{"type":"boolean"},"has_issues":{"type":"boolean"},"has_pages":{"type":"boolean"},"has_projects":{"type":"boolean"},"has_wiki":{"type":"boolean"},"homepage":{"format":"uri","nullable":true,"type":"string"},"hooks_url":{"format":"uri","type":"string"},"html_url":{"format":"uri","type":"string"},"id":{"type":"integer"},"is_template":{"type":"boolean"},"issue_comment_url":{"type":"string"},"issue_events_url":{"type":"string"},"issues_url":{"type":"string"},"keys_url":{"type":"string"},"labels_url":{"type":"string"},"language":{"nullable":true,"type":"string"},"languages_url":{"format":"uri","type":"string"},"license":{"$ref":"#/components/schemas/nullable-license-simple"},"master_branch":{"type":"string"},"merges_url":{"format":"uri","type":"string"},"milestones_url":{"type":"string"},"mirror_url":{"format":"uri","nullable":true,"type":"string"},"name":{"type":"string"},"node_id":{"type":"string"},"notifications_url":{"type":"string"},"open_issues":{"type":"integer"},"open_issues_count":{"type":"integer"},"owner":{"properties":{"avatar_url":{"format":"uri","type":"string"},"events_url":{"type":"string"},"followers_url":{"format":"uri","type":"string"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"gravatar_id":{"nullable":true,"type":"string"},"html_url":{"format":"uri","type":"string"},"id":{"type":"integer"},"login":{"type":"string"},"node_id":{"type":"string"},"organizations_url":{"format":"uri","type":"string"},"received_events_url":{"format":"uri","type":"string"},"repos_url":{"format":"uri","type":"string"},"site_admin":{"type":"boolean"},"starred_url":{"type":"string"},"subscriptions_url":{"format":"uri","type":"string"},"type":{"type":"string"},"url":{"format":"uri","type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url"],"type":"object"},"permissions":{"properties":{"admin":{"type":"boolean"},"maintain":{"type":"boolean"},"pull":{"type":"boolean"},"push":{"type":"boolean"},"triage":{"type":"boolean"}},"required":["admin","pull","push"],"type":"object"},"private":{"type":"boolean"},"pulls_url":{"type":"string"},"pushed_at":{"format":"date-time","type":"string"},"releases_url":{"type":"string"},"size":{"type":"integer"},"ssh_url":{"type":"string"},"stargazers_count":{"type":"integer"},"stargazers_url":{"format":"uri","type":"string"},"statuses_url":{"type":"string"},"subscribers_url":{"format":"uri","type":"string"},"subscription_url":{"format":"uri","type":"string"},"svn_url":{"format":"uri","type":"string"},"tags_url":{"format":"uri","type":"string"},"teams_url":{"format":"uri","type":"string"},"temp_clone_token":{"type":"string"},"topics":{"items":{"type":"string"},"type":"array"},"trees_url":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"url":{"format":"uri","type":"string"},"visibility":{"description":"The repository visibility: public, private, or internal.","type":"string"},"watchers":{"type":"integer"},"watchers_count":{"type":"integer"}},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_downloads","has_issues","has_projects","has_wiki","has_pages","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at"],"type":"object"},"sha":{"type":"string"},"user":{"properties":{"avatar_url":{"format":"uri","type":"string"},"events_url":{"type":"string"},"followers_url":{"format":"uri","type":"string"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"gravatar_id":{"nullable":true,"type":"string"},"html_url":{"format":"uri","type":"string"},"id":{"type":"integer"},"login":{"type":"string"},"node_id":{"type":"string"},"organizations_url":{"format":"uri","type":"string"},"received_events_url":{"format":"uri","type":"string"},"repos_url":{"format":"uri","type":"string"},"site_admin":{"type":"boolean"},"starred_url":{"type":"string"},"subscriptions_url":{"format":"uri","type":"string"},"type":{"type":"string"},"url":{"format":"uri","type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url"],"type":"object"}},"required":["label","ref","repo","sha","user"],"type":"object"},"body":{"example":"Please pull these awesome changes","nullable":true,"type":"string"},"changed_files":{"example":5,"type":"integer"},"closed_at":{"example":"2011-01-26T19:01:12Z","format":"date-time","nullable":true,"type":"string"},"comments":{"example":10,"type":"integer"},"comments_url":{"example":"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments","format":"uri","type":"string"},"commits":{"example":3,"type":"integer"},"commits_url":{"example":"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits","format":"uri","type":"string"},"created_at":{"example":"2011-01-26T19:01:12Z","format":"date-time","type":"string"},"deletions":{"example":3,"type":"integer"},"diff_url":{"example":"https://github.com/octocat/Hello-World/pull/1347.diff","format":"uri","type":"string"},"draft":{"description":"Indicates whether or not the pull request is a draft.","example":false,"type":"boolean"},"head":{"properties":{"label":{"type":"string"},"ref":{"type":"string"},"repo":{"nullable":true,"properties":{"allow_forking":{"type":"boolean"},"allow_merge_commit":{"type":"boolean"},"allow_rebase_merge":{"type":"boolean"},"allow_squash_merge":{"type":"boolean"},"archive_url":{"type":"string"},"archived":{"type":"boolean"},"assignees_url":{"type":"string"},"blobs_url":{"type":"string"},"branches_url":{"type":"string"},"clone_url":{"type":"string"},"collaborators_url":{"type":"string"},"comments_url":{"type":"string"},"commits_url":{"type":"string"},"compare_url":{"type":"string"},"contents_url":{"type":"string"},"contributors_url":{"format":"uri","type":"string"},"created_at":{"format":"date-time","type":"string"},"default_branch":{"type":"string"},"deployments_url":{"format":"uri","type":"string"},"description":{"nullable":true,"type":"string"},"disabled":{"type":"boolean"},"downloads_url":{"format":"uri","type":"string"},"events_url":{"format":"uri","type":"string"},"fork":{"type":"boolean"},"forks":{"type":"integer"},"forks_count":{"type":"integer"},"forks_url":{"format":"uri","type":"string"},"full_name":{"type":"string"},"git_commits_url":{"type":"string"},"git_refs_url":{"type":"string"},"git_tags_url":{"type":"string"},"git_url":{"type":"string"},"has_downloads":{"type":"boolean"},"has_issues":{"type":"boolean"},"has_pages":{"type":"boolean"},"has_projects":{"type":"boolean"},"has_wiki":{"type":"boolean"},"homepage":{"format":"uri","nullable":true,"type":"string"},"hooks_url":{"format":"uri","type":"string"},"html_url":{"format":"uri","type":"string"},"id":{"type":"integer"},"is_template":{"type":"boolean"},"issue_comment_url":{"type":"string"},"issue_events_url":{"type":"string"},"issues_url":{"type":"string"},"keys_url":{"type":"string"},"labels_url":{"type":"string"},"language":{"nullable":true,"type":"string"},"languages_url":{"format":"uri","type":"string"},"license":{"nullable":true,"properties":{"key":{"type":"string"},"name":{"type":"string"},"node_id":{"type":"string"},"spdx_id":{"nullable":true,"type":"string"},"url":{"format":"uri","nullable":true,"type":"string"}},"required":["key","name","url","spdx_id","node_id"],"type":"object"},"master_branch":{"type":"string"},"merges_url":{"format":"uri","type":"string"},"milestones_url":{"type":"string"},"mirror_url":{"format":"uri","nullable":true,"type":"string"},"name":{"type":"string"},"node_id":{"type":"string"},"notifications_url":{"type":"string"},"open_issues":{"type":"integer"},"open_issues_count":{"type":"integer"},"owner":{"properties":{"avatar_url":{"format":"uri","type":"string"},"events_url":{"type":"string"},"followers_url":{"format":"uri","type":"string"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"gravatar_id":{"nullable":true,"type":"string"},"html_url":{"format":"uri","type":"string"},"id":{"type":"integer"},"login":{"type":"string"},"node_id":{"type":"string"},"organizations_url":{"format":"uri","type":"string"},"received_events_url":{"format":"uri","type":"string"},"repos_url":{"format":"uri","type":"string"},"site_admin":{"type":"boolean"},"starred_url":{"type":"string"},"subscriptions_url":{"format":"uri","type":"string"},"type":{"type":"string"},"url":{"format":"uri","type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url"],"type":"object"},"permissions":{"properties":{"admin":{"type":"boolean"},"maintain":{"type":"boolean"},"pull":{"type":"boolean"},"push":{"type":"boolean"},"triage":{"type":"boolean"}},"required":["admin","pull","push"],"type":"object"},"private":{"type":"boolean"},"pulls_url":{"type":"string"},"pushed_at":{"format":"date-time","type":"string"},"releases_url":{"type":"string"},"size":{"type":"integer"},"ssh_url":{"type":"string"},"stargazers_count":{"type":"integer"},"stargazers_url":{"format":"uri","type":"string"},"statuses_url":{"type":"string"},"subscribers_url":{"format":"uri","type":"string"},"subscription_url":{"format":"uri","type":"string"},"svn_url":{"format":"uri","type":"string"},"tags_url":{"format":"uri","type":"string"},"teams_url":{"format":"uri","type":"string"},"temp_clone_token":{"type":"string"},"topics":{"items":{"type":"string"},"type":"array"},"trees_url":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"url":{"format":"uri","type":"string"},"visibility":{"description":"The repository visibility: public, private, or internal.","type":"string"},"watchers":{"type":"integer"},"watchers_count":{"type":"integer"}},"required":["archive_url","assignees_url","blobs_url","branches_url","collaborators_url","comments_url","commits_url","compare_url","contents_url","contributors_url","deployments_url","description","downloads_url","events_url","fork","forks_url","full_name","git_commits_url","git_refs_url","git_tags_url","hooks_url","html_url","id","node_id","issue_comment_url","issue_events_url","issues_url","keys_url","labels_url","languages_url","merges_url","milestones_url","name","notifications_url","owner","private","pulls_url","releases_url","stargazers_url","statuses_url","subscribers_url","subscription_url","tags_url","teams_url","trees_url","url","clone_url","default_branch","forks","forks_count","git_url","has_downloads","has_issues","has_projects","has_wiki","has_pages","homepage","language","archived","disabled","mirror_url","open_issues","open_issues_count","license","pushed_at","size","ssh_url","stargazers_count","svn_url","watchers","watchers_count","created_at","updated_at"],"type":"object"},"sha":{"type":"string"},"user":{"properties":{"avatar_url":{"format":"uri","type":"string"},"events_url":{"type":"string"},"followers_url":{"format":"uri","type":"string"},"following_url":{"type":"string"},"gists_url":{"type":"string"},"gravatar_id":{"nullable":true,"type":"string"},"html_url":{"format":"uri","type":"string"},"id":{"type":"integer"},"login":{"type":"string"},"node_id":{"type":"string"},"organizations_url":{"format":"uri","type":"string"},"received_events_url":{"format":"uri","type":"string"},"repos_url":{"format":"uri","type":"string"},"site_admin":{"type":"boolean"},"starred_url":{"type":"string"},"subscriptions_url":{"format":"uri","type":"string"},"type":{"type":"string"},"url":{"format":"uri","type":"string"}},"required":["avatar_url","events_url","followers_url","following_url","gists_url","gravatar_id","html_url","id","node_id","login","organizations_url","received_events_url","repos_url","site_admin","starred_url","subscriptions_url","type","url"],"type":"object"}},"required":["label","ref","repo","sha","user"],"type":"object"},"html_url":{"example":"https://github.com/octocat/Hello-World/pull/1347","format":"uri","type":"string"},"id":{"example":1,"type":"integer"},"issue_url":{"example":"https://api.github.com/repos/octocat/Hello-World/issues/1347","format":"uri","type":"string"},"labels":{"items":{"properties":{"color":{"type":"string"},"default":{"type":"boolean"},"description":{"nullable":true,"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"},"node_id":{"type":"string"},"url":{"type":"string"}},"required":["id","node_id","url","name","description","color","default"],"type":"object"},"type":"array"},"locked":{"example":true,"type":"boolean"},"maintainer_can_modify":{"description":"Indicates whether maintainers can modify the pull request.","example":true,"type":"boolean"},"merge_commit_sha":{"example":"e5bd3914e2e596debea16f433f57875b5b90bcd6","nullable":true,"type":"string"},"mergeable":{"example":true,"nullable":true,"type":"boolean"},"mergeable_state":{"example":"clean","type":"string"},"merged":{"type":"boolean"},"merged_at":{"example":"2011-01-26T19:01:12Z","format":"date-time","nullable":true,"type":"string"},"merged_by":{"$ref":"#/components/schemas/nullable-simple-user"},"milestone":{"$ref":"#/components/schemas/nullable-milestone"},"node_id":{"example":"MDExOlB1bGxSZXF1ZXN0MQ==","type":"string"},"number":{"description":"Number uniquely identifying the pull request within its repository.","example":42,"type":"integer"},"patch_url":{"example":"https://github.com/octocat/Hello-World/pull/1347.patch","format":"uri","type":"string"},"rebaseable":{"example":true,"nullable":true,"type":"boolean"},"requested_reviewers":{"items":{"$ref":"#/components/schemas/simple-user"},"nullable":true,"type":"array"},"requested_teams":{"items":{"$ref":"#/components/schemas/team-simple"},"nullable":true,"type":"array"},"review_comment_url":{"example":"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}","type":"string"},"review_comments":{"example":0,"type":"integer"},"review_comments_url":{"example":"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments","format":"uri","type":"string"},"state":{"description":"State of this Pull Request. Either `open` or `closed`.","enum":["open","closed"],"example":"open","type":"string"},"statuses_url":{"example":"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e","format":"uri","type":"string"},"title":{"description":"The title of the pull request.","example":"Amazing new feature","type":"string"},"updated_at":{"example":"2011-01-26T19:01:12Z","format":"date-time","type":"string"},"url":{"example":"https://api.github.com/repos/octocat/Hello-World/pulls/1347","format":"uri","type":"string"},"user":{"$ref":"#/components/schemas/nullable-simple-user"}},"required":["_links","assignee","labels","base","body","closed_at","comments_url","commits_url","created_at","diff_url","head","html_url","id","node_id","issue_url","merge_commit_sha","merged_at","milestone","number","patch_url","review_comment_url","review_comments_url","statuses_url","state","locked","title","updated_at","url","user","author_association","additions","changed_files","comments","commits","deletions","mergeable","mergeable_state","merged","maintainer_can_modify","merged_by","review_comments"],"title":"Pull Request","type":"object"}
```