APIs.io Engineering Platform · Schema
Pull Request Review Comment
The [comment](https://docs.github.com/[email protected]/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| _links | object | |
| author_association | string | How the author is associated with the repository. |
| body | string | The text of the comment. |
| commit_id | string | The SHA of the commit to which the comment applies. |
| created_at | string | |
| diff_hunk | string | The diff of the line that the comment refers to. |
| html_url | string | HTML URL for the pull request review comment. |
| id | integer | The ID of the pull request review comment. |
| in_reply_to_id | integer | The comment ID to reply to. |
| line | integer | The line of the blob to which the comment applies. The last line of the range for a multi-line comment |
| node_id | string | The node ID of the pull request review comment. |
| original_commit_id | string | The SHA of the original commit to which the comment applies. |
| original_line | integer | The line of the blob to which the comment applies. The last line of the range for a multi-line comment |
| original_position | integer | The index of the original line in the diff to which the comment applies. |
| original_start_line | integer | The first line of the range for a multi-line comment. |
| path | string | The relative path of the file to which the comment applies. |
| position | integer | The line index in the diff to which the comment applies. |
| pull_request_review_id | integer | The ID of the pull request review to which the comment belongs. |
| pull_request_url | string | URL for the pull request that the review comment belongs to. |
| reactions | object | |
| side | string | The side of the first line of the range for a multi-line comment. |
| start_line | integer | The first line of the range for a multi-line comment. |
| start_side | string | The side of the first line of the range for a multi-line comment. |
| subject_type | string | The level at which the comment is targeted, can be a diff line or a file. |
| updated_at | string | |
| url | string | URL for the pull request review comment |
| user | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/webhooks_review_comment",
"title": "Pull Request Review Comment",
"description": "The [comment](https://docs.github.com/[email protected]/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.",
"type": "object",
"properties": {
"_links": {
"type": "object",
"properties": {
"html": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
},
"pull_request": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
},
"self": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"html",
"pull_request"
]
},
"author_association": {
"title": "AuthorAssociation",
"description": "How the author is associated with the repository.",
"type": "string",
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
"body": {
"description": "The text of the comment.",
"type": "string"
},
"commit_id": {
"description": "The SHA of the commit to which the comment applies.",
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"diff_hunk": {
"description": "The diff of the line that the comment refers to.",
"type": "string"
},
"html_url": {
"description": "HTML URL for the pull request review comment.",
"type": "string",
"format": "uri"
},
"id": {
"description": "The ID of the pull request review comment.",
"type": "integer"
},
"in_reply_to_id": {
"description": "The comment ID to reply to.",
"type": "integer"
},
"line": {
"description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
"type": "integer",
"nullable": true
},
"node_id": {
"description": "The node ID of the pull request review comment.",
"type": "string"
},
"original_commit_id": {
"description": "The SHA of the original commit to which the comment applies.",
"type": "string"
},
"original_line": {
"description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
"type": "integer"
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"type": "integer"
},
"original_start_line": {
"description": "The first line of the range for a multi-line comment.",
"type": "integer",
"nullable": true
},
"path": {
"description": "The relative path of the file to which the comment applies.",
"type": "string"
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"type": "integer",
"nullable": true
},
"pull_request_review_id": {
"description": "The ID of the pull request review to which the comment belongs.",
"type": "integer",
"nullable": true
},
"pull_request_url": {
"description": "URL for the pull request that the review comment belongs to.",
"type": "string",
"format": "uri"
},
"reactions": {
"title": "Reactions",
"type": "object",
"properties": {
"+1": {
"type": "integer"
},
"-1": {
"type": "integer"
},
"confused": {
"type": "integer"
},
"eyes": {
"type": "integer"
},
"heart": {
"type": "integer"
},
"hooray": {
"type": "integer"
},
"laugh": {
"type": "integer"
},
"rocket": {
"type": "integer"
},
"total_count": {
"type": "integer"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"total_count",
"+1",
"-1",
"laugh",
"confused",
"heart",
"hooray",
"eyes",
"rocket"
]
},
"side": {
"description": "The side of the first line of the range for a multi-line comment.",
"type": "string",
"enum": [
"LEFT",
"RIGHT"
]
},
"start_line": {
"description": "The first line of the range for a multi-line comment.",
"type": "integer",
"nullable": true
},
"start_side": {
"description": "The side of the first line of the range for a multi-line comment.",
"type": "string",
"nullable": true,
"enum": [
"LEFT",
"RIGHT",
null
],
"default": "RIGHT"
},
"subject_type": {
"description": "The level at which the comment is targeted, can be a diff line or a file.",
"type": "string",
"enum": [
"line",
"file"
]
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"description": "URL for the pull request review comment",
"type": "string",
"format": "uri"
},
"user": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer",
"format": "int64"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"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",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
}
},
"required": [
"url",
"pull_request_review_id",
"id",
"node_id",
"diff_hunk",
"path",
"position",
"original_position",
"commit_id",
"original_commit_id",
"user",
"body",
"created_at",
"updated_at",
"html_url",
"pull_request_url",
"author_association",
"_links",
"start_line",
"original_start_line",
"original_line",
"line",
"start_side",
"side",
"reactions"
]
}