Legacy Review Comment

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
url	string
pull_request_review_id	integer
id	integer
node_id	string
diff_hunk	string
path	string
position	integer
original_position	integer
commit_id	string
original_commit_id	string
in_reply_to_id	integer
user	object
body	string
created_at	string
updated_at	string
html_url	string
pull_request_url	string
author_association	object
_links	object
body_text	string
body_html	string
reactions	object
side	string	The side of 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 original line of the blob to which the comment applies. The last line of the range for a multi-line comment
start_line	integer	The first line of the range for a multi-line comment.
original_start_line	integer	The original first line of the range for a multi-line comment.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/review-comment",
  "title": "Legacy Review Comment",
  "description": "Legacy Review Comment",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
    },
    "pull_request_review_id": {
      "type": "integer",
      "format": "int64",
      "example": 42,
      "nullable": true
    },
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 10
    },
    "node_id": {
      "type": "string",
      "example": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw"
    },
    "diff_hunk": {
      "type": "string",
      "example": "@@ -16,33 +16,40 @@ public class Connection : IConnection..."
    },
    "path": {
      "type": "string",
      "example": "file1.txt"
    },
    "position": {
      "type": "integer",
      "example": 1,
      "nullable": true
    },
    "original_position": {
      "type": "integer",
      "example": 4
    },
    "commit_id": {
      "type": "string",
      "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
    },
    "original_commit_id": {
      "type": "string",
      "example": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840"
    },
    "in_reply_to_id": {
      "type": "integer",
      "example": 8
    },
    "user": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "body": {
      "type": "string",
      "example": "Great stuff"
    },
    "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": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
    },
    "pull_request_url": {
      "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": {
          "$ref": "#/components/schemas/link"
        },
        "html": {
          "$ref": "#/components/schemas/link"
        },
        "pull_request": {
          "$ref": "#/components/schemas/link"
        }
      },
      "required": [
        "self",
        "html",
        "pull_request"
      ]
    },
    "body_text": {
      "type": "string"
    },
    "body_html": {
      "type": "string"
    },
    "reactions": {
      "$ref": "#/components/schemas/reaction-rollup"
    },
    "side": {
      "description": "The side of the first line of the range for a multi-line comment.",
      "enum": [
        "LEFT",
        "RIGHT"
      ],
      "default": "RIGHT",
      "type": "string"
    },
    "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 original line of the blob to which the comment applies. The last line of the range for a multi-line comment",
      "example": 2,
      "type": "integer"
    },
    "start_line": {
      "description": "The first line of the range for a multi-line comment.",
      "example": 2,
      "type": "integer",
      "nullable": true
    },
    "original_start_line": {
      "description": "The original first line of the range for a multi-line comment.",
      "example": 2,
      "type": "integer",
      "nullable": true
    }
  },
  "required": [
    "id",
    "node_id",
    "url",
    "body",
    "diff_hunk",
    "path",
    "position",
    "original_position",
    "commit_id",
    "original_commit_id",
    "user",
    "pull_request_review_id",
    "html_url",
    "pull_request_url",
    "_links",
    "author_association",
    "created_at",
    "updated_at"
  ]
}