{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/github/main/json-schema/github-pull-request-review-comment-schema.json", "title": "Pull Request Review Comment", "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", "x-generated": "2026-10-03", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/github-pulls-api-openapi.yml#/components/schemas/pull-request-review-comment", "type": "object", "properties": { "url": { "description": "URL for the pull request review comment", "type": "string" }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": [ "integer", "null" ] }, "id": { "description": "The ID of the pull request review comment.", "type": "integer" }, "node_id": { "description": "The node ID of the pull request review comment.", "type": "string" }, "diff_hunk": { "description": "The diff of the line that the comment refers to.", "type": "string" }, "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. This field is deprecated; use `line` instead.", "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.", "type": "integer" }, "commit_id": { "description": "The SHA of the commit to which the comment applies.", "type": "string" }, "original_commit_id": { "description": "The SHA of the original commit to which the comment applies.", "type": "string" }, "in_reply_to_id": { "description": "The comment ID to reply to.", "type": "integer" }, "user": { "$ref": "#/$defs/simple-user" }, "body": { "description": "The text of the comment.", "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "html_url": { "description": "HTML URL for the pull request review comment.", "type": "string", "format": "uri" }, "pull_request_url": { "description": "URL for the pull request that the review comment belongs to.", "type": "string", "format": "uri" }, "author_association": { "$ref": "#/$defs/author-association" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri" } }, "required": [ "href" ] }, "html": { "type": "object", "properties": { "href": { "type": "string", "format": "uri" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string", "format": "uri" } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment." }, "original_start_line": { "type": [ "integer", "null" ], "description": "The first line of the range for a multi-line comment." }, "start_side": { "type": [ "string", "null" ], "description": "The side of the first line of the range for a multi-line comment.", "enum": [ "LEFT", "RIGHT" ], "default": "RIGHT" }, "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_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" }, "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": "#/$defs/reaction-rollup" }, "body_html": { "type": "string" }, "body_text": { "type": "string" } }, "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" ], "$defs": { "author-association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "reaction-rollup": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "simple-user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string" } }, "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" ] } } }