APIs.io Engineering Platform · Schema
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.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| url | string | |
| id | integer | |
| node_id | string | |
| html_url | string | |
| diff_url | string | |
| patch_url | string | |
| issue_url | string | |
| commits_url | string | |
| review_comments_url | string | |
| review_comment_url | string | |
| comments_url | string | |
| statuses_url | string | |
| number | integer | Number uniquely identifying the pull request within its repository. |
| state | string | State of this Pull Request. Either `open` or `closed`. |
| locked | boolean | |
| title | string | The title of the pull request. |
| user | object | |
| body | string | |
| labels | array | |
| milestone | object | |
| active_lock_reason | string | |
| created_at | string | |
| updated_at | string | |
| closed_at | string | |
| merged_at | string | |
| merge_commit_sha | string | |
| assignee | object | |
| assignees | array | |
| requested_reviewers | array | |
| requested_teams | array | |
| head | object | |
| base | object | |
| _links | object | |
| author_association | object | |
| auto_merge | object | |
| draft | boolean | Indicates whether or not the pull request is a draft. |
| merged | boolean | |
| mergeable | boolean | |
| rebaseable | boolean | |
| mergeable_state | string | |
| merged_by | object | |
| comments | integer | |
| review_comments | integer | |
| maintainer_can_modify | boolean | Indicates whether maintainers can modify the pull request. |
| commits | integer | |
| additions | integer | |
| deletions | integer | |
| changed_files | integer |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/pull-request",
"title": "Pull Request",
"type": "object",
"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",
"format": "int64",
"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/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"
},
"has_discussions": {
"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"
},
"web_commit_signoff_required": {
"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",
"has_discussions",
"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",
"format": "int64"
},
"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"
},
"has_discussions": {
"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"
},
"web_commit_signoff_required": {
"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",
"p
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/json-schema/apis-io-engineering-platform-pull-request-schema.json