APIs.io Engineering Platform · Schema
Pull Request Simple
Pull Request Simple
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 | |
| state | string | |
| locked | boolean | |
| title | string | |
| 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. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/pull-request-simple",
"title": "Pull Request Simple",
"description": "Pull Request Simple",
"type": "object",
"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": {
"type": "integer",
"example": 1347
},
"state": {
"type": "string",
"example": "open"
},
"locked": {
"type": "boolean",
"example": true
},
"title": {
"type": "string",
"example": "new-feature"
},
"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"
},
"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"
},
"nullable": true
},
"head": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"ref": {
"type": "string"
},
"repo": {
"$ref": "#/components/schemas/repository"
},
"sha": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/nullable-simple-user"
}
},
"required": [
"label",
"ref",
"repo",
"sha",
"user"
]
},
"base": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"ref": {
"type": "string"
},
"repo": {
"$ref": "#/components/schemas/repository"
},
"sha": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/nullable-simple-user"
}
},
"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"
},
"auto_merge": {
"$ref": "#/components/schemas/auto-merge"
},
"draft": {
"description": "Indicates whether or not the pull request is a draft.",
"example": false,
"type": "boolean"
}
},
"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",
"auto_merge"
]
}