GitHub · Schema
GitHub Pull Request
A GitHub pull request representing a proposed change to a repository, including metadata for code review, merging, and CI/CD status.
CodePipelinesPlatformSoftware DevelopmentSource ControlT1
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | The unique identifier of the pull request. |
| node_id | string | The GraphQL node ID for the pull request. |
| url | string | The API URL for the pull request. |
| html_url | string | The URL of the pull request on GitHub. |
| diff_url | string | The URL to the pull request diff. |
| patch_url | string | The URL to the pull request patch. |
| number | integer | The pull request number within the repository. |
| state | string | The current state of the pull request. |
| locked | boolean | Whether the pull request is locked. |
| title | string | The title of the pull request. |
| body | stringnull | The contents of the pull request description in Markdown format. |
| user | object | |
| labels | array | Labels applied to the pull request. |
| assignees | array | Users assigned to the pull request. |
| requested_reviewers | array | Users requested to review the pull request. |
| requested_teams | array | Teams requested to review the pull request. |
| head | object | |
| base | object | |
| draft | boolean | Whether the pull request is a draft. |
| merged | boolean | Whether the pull request has been merged. |
| mergeable | booleannull | Whether the pull request can be merged. Null if not yet computed. |
| mergeable_state | string | The mergeability state of the pull request. |
| merge_commit_sha | stringnull | The SHA of the merge commit, if merged. |
| merged_by | object | The user who merged the pull request. |
| comments | integer | The number of comments on the pull request. |
| review_comments | integer | The number of review comments on the pull request. |
| commits | integer | The number of commits in the pull request. |
| additions | integer | The number of lines added. |
| deletions | integer | The number of lines deleted. |
| changed_files | integer | The number of changed files. |
| created_at | string | The date and time the pull request was created. |
| updated_at | string | The date and time the pull request was last updated. |
| closed_at | stringnull | The date and time the pull request was closed. |
| merged_at | stringnull | The date and time the pull request was merged. |
| auto_merge | objectnull | Auto-merge configuration if enabled. |
| author_association | string | How the author is associated with the repository. |