--- title: "Pull Request" url: "https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4/schemas/pull-request" --- > Full API specification: https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4.md # 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. ## OpenAPI definition ```yaml openapi: 3.0.3 info: title: GitHub v3 REST API version: 1.1.4 servers: - url: "{protocol}://{hostname}/api/v3" variables: hostname: description: Self-hosted Enterprise Server or Enterprise Cloud hostname default: HOSTNAME protocol: description: Self-hosted Enterprise Server or Enterprise Cloud protocol default: http components: schemas: nullable-simple-user: title: Simple User description: Simple User type: object properties: name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' 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 nullable: true nullable-milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: type: string format: uri example: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: type: integer example: 1002604 node_id: type: string example: MDk6TWlsZXN0b25lMTAwMjYwNA== number: description: The number of the milestone. type: integer example: 42 state: description: The state of the milestone. example: open type: string enum: - open - closed default: open title: description: The title of the milestone. example: v1.0 type: string description: type: string example: Tracking milestone for version 1.0 nullable: true creator: $ref: "#/components/schemas/nullable-simple-user" open_issues: type: integer example: 4 closed_issues: type: integer example: 8 created_at: type: string format: date-time example: 2011-04-10T20:09:31Z updated_at: type: string format: date-time example: 2014-03-03T18:58:10Z closed_at: type: string format: date-time example: 2013-02-12T13:22:01Z nullable: true due_on: type: string format: date-time example: 2012-10-09T23:39:01Z nullable: true required: - closed_issues - creator - description - due_on - closed_at - id - node_id - labels_url - html_url - number - open_issues - state - title - url - created_at - updated_at nullable: true simple-user: title: Simple User description: Simple User type: object properties: name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' 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 team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: description: Unique identifier of the team type: integer example: 1 node_id: type: string example: MDQ6VGVhbTE= url: description: URL for the team type: string format: uri example: https://api.github.com/organizations/1/team/1 members_url: type: string example: https://api.github.com/organizations/1/team/1/members{/member} name: description: Name of the team type: string example: Justice League description: description: Description of the team type: string nullable: true example: A great team. permission: description: Permission that the team will have for its repositories type: string example: admin privacy: description: The level of privacy this team should have type: string example: closed html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core repositories_url: type: string format: uri example: https://api.github.com/organizations/1/team/1/repos slug: type: string example: justice-league ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug nullable-license-simple: title: License Simple description: License Simple type: object properties: key: type: string example: mit name: type: string example: MIT License url: type: string nullable: true format: uri example: https://api.github.com/licenses/mit spdx_id: type: string nullable: true example: MIT node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri required: - key - name - url - spdx_id - node_id nullable: true link: title: Link description: Hypermedia Link type: object properties: href: type: string required: - href author_association: title: author_association type: string example: OWNER description: How the author is associated with the repository. enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER pull-request: type: object title: Pull Request 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: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer example: 1 node_id: type: string example: MDExOlB1bGxSZXF1ZXN0MQ== html_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347 diff_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347.diff patch_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347.patch issue_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/issues/1347 commits_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits review_comments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments review_comment_url: type: string example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} comments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e number: description: Number uniquely identifying the pull request within its repository. example: 42 type: integer state: description: State of this Pull Request. Either `open` or `closed`. enum: - open - closed example: open type: string locked: type: boolean example: true title: description: The title of the pull request. example: Amazing new feature type: string user: $ref: "#/components/schemas/nullable-simple-user" body: type: string example: Please pull these awesome changes nullable: true labels: type: array items: type: object properties: id: type: integer format: int64 node_id: type: string url: type: string name: type: string description: type: string nullable: true color: type: string default: type: boolean required: - id - node_id - url - name - description - color - default milestone: $ref: "#/components/schemas/nullable-milestone" active_lock_reason: type: string example: too heated nullable: true created_at: type: string format: date-time example: 2011-01-26T19:01:12Z updated_at: type: string format: date-time example: 2011-01-26T19:01:12Z closed_at: type: string format: date-time example: 2011-01-26T19:01:12Z nullable: true merged_at: type: string format: date-time example: 2011-01-26T19:01:12Z nullable: true merge_commit_sha: type: string example: e5bd3914e2e596debea16f433f57875b5b90bcd6 nullable: true assignee: $ref: "#/components/schemas/nullable-simple-user" assignees: type: array items: $ref: "#/components/schemas/simple-user" nullable: true requested_reviewers: type: array items: $ref: "#/components/schemas/simple-user" nullable: true requested_teams: type: array items: $ref: "#/components/schemas/team-simple" nullable: true head: type: object properties: label: type: string ref: type: string repo: type: object nullable: true properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_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: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string format: uri html_url: type: string format: uri id: type: integer node_id: type: string issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string name: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string format: uri events_url: type: string followers_url: type: string format: uri following_url: type: string gists_url: type: string gravatar_id: type: string nullable: true html_url: type: string format: uri id: type: integer node_id: type: string login: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string subscriptions_url: type: string format: uri type: type: string url: type: string format: uri 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 private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string format: uri statuses_url: type: string subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string url: type: string format: uri clone_url: type: string default_branch: type: string forks: type: integer forks_count: type: integer git_url: type: string has_downloads: type: boolean has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean homepage: type: string format: uri nullable: true language: type: string nullable: true master_branch: type: string archived: type: boolean disabled: type: boolean visibility: description: "The repository visibility: public, private, or internal." type: string mirror_url: type: string format: uri nullable: true open_issues: type: integer open_issues_count: type: integer permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean required: - admin - pull - push temp_clone_token: type: string allow_merge_commit: type: boolean allow_squash_merge: type: boolean allow_rebase_merge: type: boolean license: type: object properties: key: type: string name: type: string url: type: string format: uri nullable: true spdx_id: type: string nullable: true node_id: type: string required: - key - name - url - spdx_id - node_id nullable: true pushed_at: type: string format: date-time size: type: integer ssh_url: type: string stargazers_count: type: integer svn_url: type: string format: uri topics: type: array items: type: string watchers: type: integer watchers_count: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time allow_forking: type: boolean is_template: type: boolean 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 sha: type: string user: type: object properties: avatar_url: type: string format: uri events_url: type: string followers_url: type: string format: uri following_url: type: string gists_url: type: string gravatar_id: type: string nullable: true html_url: type: string format: uri id: type: integer node_id: type: string login: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string subscriptions_url: type: string format: uri type: type: string url: type: string format: uri 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 required: - label - ref - repo - sha - user base: type: object properties: label: type: string ref: type: string repo: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_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: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string format: uri html_url: type: string format: uri id: type: integer is_template: type: boolean node_id: type: string issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string name: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string format: uri events_url: type: string followers_url: type: string format: uri following_url: type: string gists_url: type: string gravatar_id: type: string nullable: true html_url: type: string format: uri id: type: integer node_id: type: string login: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string subscriptions_url: type: string format: uri type: type: string url: type: string format: uri 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 private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string format: uri statuses_url: type: string subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string url: type: string format: uri clone_url: type: string default_branch: type: string forks: type: integer forks_count: type: integer git_url: type: string has_downloads: type: boolean has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean homepage: type: string format: uri nullable: true language: type: string nullable: true master_branch: type: string archived: type: boolean disabled: type: boolean visibility: description: "The repository visibility: public, private, or internal." type: string mirror_url: type: string format: uri nullable: true open_issues: type: integer open_issues_count: type: integer permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean required: - admin - pull - push temp_clone_token: type: string allow_merge_commit: type: boolean allow_squash_merge: type: boolean allow_rebase_merge: type: boolean license: $ref: "#/components/schemas/nullable-license-simple" pushed_at: type: string format: date-time size: type: integer ssh_url: type: string stargazers_count: type: integer svn_url: type: string format: uri topics: type: array items: type: string watchers: type: integer watchers_count: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time allow_forking: type: boolean 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 sha: type: string user: type: object properties: avatar_url: type: string format: uri events_url: type: string followers_url: type: string format: uri following_url: type: string gists_url: type: string gravatar_id: type: string nullable: true html_url: type: string format: uri id: type: integer node_id: type: string login: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string subscriptions_url: type: string format: uri type: type: string url: type: string format: uri 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 required: - label - ref - repo - sha - user _links: type: object properties: comments: $ref: "#/components/schemas/link" commits: $ref: "#/components/schemas/link" statuses: $ref: "#/components/schemas/link" html: $ref: "#/components/schemas/link" issue: $ref: "#/components/schemas/link" review_comments: $ref: "#/components/schemas/link" review_comment: $ref: "#/components/schemas/link" self: $ref: "#/components/schemas/link" required: - comments - commits - statuses - html - issue - review_comments - review_comment - self author_association: $ref: "#/components/schemas/author_association" draft: description: Indicates whether or not the pull request is a draft. example: false type: boolean merged: type: boolean mergeable: type: boolean example: true nullable: true rebaseable: type: boolean example: true nullable: true mergeable_state: type: string example: clean merged_by: $ref: "#/components/schemas/nullable-simple-user" comments: type: integer example: 10 review_comments: type: integer example: 0 maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. example: true type: boolean commits: type: integer example: 3 additions: type: integer example: 100 deletions: type: integer example: 3 changed_files: type: integer example: 5 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 ```