APIs.io Engineering Platform · Schema
Pull Request Review Comment
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| url | string | URL for the pull request review comment |
| pull_request_review_id | integer | The ID of the pull request review to which the comment belongs. |
| id | integer | The ID of the pull request review comment. |
| node_id | string | The node ID of the pull request review comment. |
| diff_hunk | string | The diff of the line that the comment refers to. |
| 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. This field is deprecated; use `line` instead. |
| original_position | integer | The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. |
| commit_id | string | The SHA of the commit to which the comment applies. |
| original_commit_id | string | The SHA of the original commit to which the comment applies. |
| in_reply_to_id | integer | The comment ID to reply to. |
| user | object | |
| body | string | The text of the comment. |
| created_at | string | |
| updated_at | string | |
| html_url | string | HTML URL for the pull request review comment. |
| pull_request_url | string | URL for the pull request that the review comment belongs to. |
| author_association | object | |
| _links | object | |
| start_line | integer | The first line of the range for a multi-line comment. |
| original_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. |
| line | integer | The line of the blob to which the comment applies. The last line of the range for a multi-line comment |
| original_line | integer | The line of the blob to which the comment applies. The last line of the range for a multi-line comment |
| side | string | The side of the diff to which the comment applies. The side of the last 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. |
| reactions | object | |
| body_html | string | |
| body_text | string |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/pull-request-review-comment",
"title": "Pull Request Review Comment",
"description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.",
"type": "object",
"properties": {
"url": {
"description": "URL for the pull request review comment",
"example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
"type": "string"
},
"pull_request_review_id": {
"description": "The ID of the pull request review to which the comment belongs.",
"type": "integer",
"format": "int64",
"example": 42,
"nullable": true
},
"id": {
"description": "The ID of the pull request review comment.",
"type": "integer",
"format": "int64",
"example": 1
},
"node_id": {
"description": "The node ID of the pull request review comment.",
"type": "string",
"example": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw"
},
"diff_hunk": {
"description": "The diff of the line that the comment refers to.",
"type": "string",
"example": "@@ -16,33 +16,40 @@ public class Connection : IConnection..."
},
"path": {
"description": "The relative path of the file to which the comment applies.",
"example": "config/database.yaml",
"type": "string"
},
"position": {
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"example": 1,
"type": "integer"
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"example": 4,
"type": "integer"
},
"commit_id": {
"description": "The SHA of the commit to which the comment applies.",
"example": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"type": "string"
},
"original_commit_id": {
"description": "The SHA of the original commit to which the comment applies.",
"example": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840",
"type": "string"
},
"in_reply_to_id": {
"description": "The comment ID to reply to.",
"example": 8,
"type": "integer"
},
"user": {
"$ref": "#/components/schemas/simple-user"
},
"body": {
"description": "The text of the comment.",
"example": "We should probably include a check for null values here.",
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2011-04-14T16:00:49Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2011-04-14T16:00:49Z"
},
"html_url": {
"description": "HTML URL for the pull request review comment.",
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
},
"pull_request_url": {
"description": "URL for the pull request that the review comment belongs to.",
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
},
"author_association": {
"$ref": "#/components/schemas/author-association"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
}
},
"required": [
"href"
]
},
"html": {
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
}
},
"required": [
"href"
]
},
"pull_request": {
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"html",
"pull_request"
]
},
"start_line": {
"type": "integer",
"description": "The first line of the range for a multi-line comment.",
"example": 2,
"nullable": true
},
"original_start_line": {
"type": "integer",
"description": "The first line of the range for a multi-line comment.",
"example": 2,
"nullable": true
},
"start_side": {
"type": "string",
"description": "The side of the first line of the range for a multi-line comment.",
"enum": [
"LEFT",
"RIGHT"
],
"default": "RIGHT",
"nullable": true
},
"line": {
"description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
"example": 2,
"type": "integer"
},
"original_line": {
"description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
"example": 2,
"type": "integer"
},
"side": {
"description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment",
"enum": [
"LEFT",
"RIGHT"
],
"default": "RIGHT",
"type": "string"
},
"subject_type": {
"description": "The level at which the comment is targeted, can be a diff line or a file.",
"type": "string",
"enum": [
"line",
"file"
]
},
"reactions": {
"$ref": "#/components/schemas/reaction-rollup"
},
"body_html": {
"type": "string",
"example": "\"<p>comment body</p>\""
},
"body_text": {
"type": "string",
"example": "\"comment body\""
}
},
"required": [
"url",
"id",
"node_id",
"pull_request_review_id",
"diff_hunk",
"path",
"commit_id",
"original_commit_id",
"user",
"body",
"created_at",
"updated_at",
"html_url",
"pull_request_url",
"author_association",
"_links"
]
}