# pull-request-review-comment

From **GitHub v3 REST API**.

Pull Request Review Comments are comments on a portion of the Pull Request's diff.

- Type: `object`

## Properties

### `_links`

- Required: true
- Type: `object`

### `author_association`

- Required: true
- Type: `string`
- Example: `OWNER`
- Allowed values: `"COLLABORATOR"`, `"CONTRIBUTOR"`, `"FIRST_TIMER"`, `"FIRST_TIME_CONTRIBUTOR"`, `"MANNEQUIN"`, `"MEMBER"`, `"NONE"`, `"OWNER"`

How the author is associated with the repository.

### `body`

- Required: true
- Type: `string`
- Example: `We should probably include a check for null values here.`

The text of the comment.

### `body_html`

- Required: false
- Type: `string`
- Example: `"<p>comment body</p>"`

### `body_text`

- Required: false
- Type: `string`
- Example: `"comment body"`

### `commit_id`

- Required: true
- Type: `string`
- Example: `6dcb09b5b57875f334f61aebed695e2e4193db5e`

The SHA of the commit to which the comment applies.

### `created_at`

- Required: true
- Type: `string`
- Format: `date-time`
- Example: `2011-04-14T16:00:49Z`

### `diff_hunk`

- Required: true
- Type: `string`
- Example: `@@ -16,33 +16,40 @@ public class Connection : IConnection...`

The diff of the line that the comment refers to.

### `html_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://github.com/octocat/Hello-World/pull/1#discussion-diff-1`

HTML URL for the pull request review comment.

### `id`

- Required: true
- Type: `integer`
- Example: `1`

The ID of the pull request review comment.

### `in_reply_to_id`

- Required: false
- Type: `integer`
- Example: `8`

The comment ID to reply to.

### `line`

- Required: false
- Type: `integer`
- Example: `2`

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

### `node_id`

- Required: true
- Type: `string`
- Example: `MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw`

The node ID of the pull request review comment.

### `original_commit_id`

- Required: true
- Type: `string`
- Example: `9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840`

The SHA of the original commit to which the comment applies.

### `original_line`

- Required: false
- Type: `integer`
- Example: `2`

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

### `original_position`

- Required: true
- Type: `integer`
- Example: `4`

The index of the original line in the diff to which the comment applies.

### `original_start_line`

- Required: false
- Type: `integer`
- Nullable: true
- Example: `2`

The first line of the range for a multi-line comment.

### `path`

- Required: true
- Type: `string`
- Example: `config/database.yaml`

The relative path of the file to which the comment applies.

### `position`

- Required: true
- Type: `integer`
- Example: `1`

The line index in the diff to which the comment applies.

### `pull_request_review_id`

- Required: true
- Type: `integer`
- Nullable: true
- Example: `42`

The ID of the pull request review to which the comment belongs.

### `pull_request_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://api.github.com/repos/octocat/Hello-World/pulls/1`

URL for the pull request that the review comment belongs to.

### `reactions`

- Required: false
- Type: `object`

### `side`

- Required: false
- Type: `string`
- Default: `RIGHT`
- Allowed values: `"LEFT"`, `"RIGHT"`

The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment

### `start_line`

- Required: false
- Type: `integer`
- Nullable: true
- Example: `2`

The first line of the range for a multi-line comment.

### `start_side`

- Required: false
- Type: `string`
- Nullable: true
- Default: `RIGHT`
- Allowed values: `"LEFT"`, `"RIGHT"`

The side of the first line of the range for a multi-line comment.

### `updated_at`

- Required: true
- Type: `string`
- Format: `date-time`
- Example: `2011-04-14T16:00:49Z`

### `url`

- Required: true
- Type: `string`
- Example: `https://api.github.com/repos/octocat/Hello-World/pulls/comments/1`

URL for the pull request review comment

### `user`

- Required: true
- Type: `object`

Simple User

## JSON Schema

```json
{"description":"Pull Request Review Comments are comments on a portion of the Pull Request's diff.","properties":{"_links":{"properties":{"html":{"properties":{"href":{"example":"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1","format":"uri","type":"string"}},"required":["href"],"type":"object"},"pull_request":{"properties":{"href":{"example":"https://api.github.com/repos/octocat/Hello-World/pulls/1","format":"uri","type":"string"}},"required":["href"],"type":"object"},"self":{"properties":{"href":{"example":"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1","format":"uri","type":"string"}},"required":["href"],"type":"object"}},"required":["self","html","pull_request"],"type":"object"},"author_association":{"$ref":"#/components/schemas/author_association"},"body":{"description":"The text of the comment.","example":"We should probably include a check for null values here.","type":"string"},"body_html":{"example":"\"\u003cp\u003ecomment body\u003c/p\u003e\"","type":"string"},"body_text":{"example":"\"comment body\"","type":"string"},"commit_id":{"description":"The SHA of the commit to which the comment applies.","example":"6dcb09b5b57875f334f61aebed695e2e4193db5e","type":"string"},"created_at":{"example":"2011-04-14T16:00:49Z","format":"date-time","type":"string"},"diff_hunk":{"description":"The diff of the line that the comment refers to.","example":"@@ -16,33 +16,40 @@ public class Connection : IConnection...","type":"string"},"html_url":{"description":"HTML URL for the pull request review comment.","example":"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1","format":"uri","type":"string"},"id":{"description":"The ID of the pull request review comment.","example":1,"type":"integer"},"in_reply_to_id":{"description":"The comment ID to reply to.","example":8,"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","example":2,"type":"integer"},"node_id":{"description":"The node ID of the pull request review comment.","example":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw","type":"string"},"original_commit_id":{"description":"The SHA of the original commit to which the comment applies.","example":"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840","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","example":2,"type":"integer"},"original_position":{"description":"The index of the original line in the diff to which the comment applies.","example":4,"type":"integer"},"original_start_line":{"description":"The first line of the range for a multi-line comment.","example":2,"nullable":true,"type":"integer"},"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.","example":1,"type":"integer"},"pull_request_review_id":{"description":"The ID of the pull request review to which the comment belongs.","example":42,"nullable":true,"type":"integer"},"pull_request_url":{"description":"URL for the pull request that the review comment belongs to.","example":"https://api.github.com/repos/octocat/Hello-World/pulls/1","format":"uri","type":"string"},"reactions":{"$ref":"#/components/schemas/reaction-rollup"},"side":{"default":"RIGHT","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"],"type":"string"},"start_line":{"description":"The first line of the range for a multi-line comment.","example":2,"nullable":true,"type":"integer"},"start_side":{"default":"RIGHT","description":"The side of the first line of the range for a multi-line comment.","enum":["LEFT","RIGHT"],"nullable":true,"type":"string"},"updated_at":{"example":"2011-04-14T16:00:49Z","format":"date-time","type":"string"},"url":{"description":"URL for the pull request review comment","example":"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1","type":"string"},"user":{"$ref":"#/components/schemas/simple-user"}},"required":["url","id","node_id","pull_request_review_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"],"title":"Pull Request Review Comment","type":"object"}
```