From 01808cf4931ff7ec20a2fea4cc60741addaf4865 Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Wed, 17 Nov 2021 04:08:30 -0500 Subject: [PATCH] Update OpenAPI Descriptions --- lib/rest/static/decorated/api.github.com.json | 46 ++++++++++--------- lib/rest/static/decorated/ghes-3.0.json | 6 ++- lib/rest/static/decorated/ghes-3.1.json | 6 ++- lib/rest/static/decorated/ghes-3.2.json | 6 ++- lib/rest/static/decorated/ghes-3.3.json | 46 ++++++++++--------- lib/rest/static/decorated/github.ae.json | 46 ++++++++++--------- .../dereferenced/api.github.com.deref.json | 13 +++--- .../static/dereferenced/ghes-3.0.deref.json | 3 +- .../static/dereferenced/ghes-3.1.deref.json | 3 +- .../static/dereferenced/ghes-3.2.deref.json | 3 +- .../static/dereferenced/ghes-3.3.deref.json | 13 +++--- .../static/dereferenced/github.ae.deref.json | 13 +++--- 12 files changed, 111 insertions(+), 93 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index ae1bfddfa634..b95304379a54 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -71284,16 +71284,16 @@ }, "position": { "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", + "description": "

Required without comfort-fade preview unless using in_reply_to. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, "side": { "type": "string", - "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", "enum": [ "LEFT", "RIGHT" @@ -71301,30 +71301,30 @@ "name": "side", "in": "body", "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "childParamsGroups": [] }, "line": { "type": "integer", - "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", "childParamsGroups": [] }, "start_line": { "type": "integer", - "description": "

Required when using multi-line comments. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", "rawType": "integer", - "rawDescription": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "childParamsGroups": [] }, "start_side": { "type": "string", - "description": "

Required when using multi-line comments. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", "enum": [ "LEFT", "RIGHT", @@ -71333,16 +71333,17 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, "in_reply_to": { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } }, @@ -71422,16 +71423,16 @@ }, { "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", + "description": "

Required without comfort-fade preview unless using in_reply_to. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, { "type": "string", - "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", "enum": [ "LEFT", "RIGHT" @@ -71439,30 +71440,30 @@ "name": "side", "in": "body", "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "childParamsGroups": [] }, { "type": "integer", - "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", "childParamsGroups": [] }, { "type": "integer", - "description": "

Required when using multi-line comments. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", "rawType": "integer", - "rawDescription": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "childParamsGroups": [] }, { "type": "string", - "description": "

Required when using multi-line comments. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", "enum": [ "LEFT", "RIGHT", @@ -71471,16 +71472,17 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } ], diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 3295960a88a4..5429953469d7 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -66293,10 +66293,11 @@ "in_reply_to": { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } }, @@ -66439,10 +66440,11 @@ { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } ], diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index d9b0dd5f17af..46d7ff1ba421 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -66962,10 +66962,11 @@ "in_reply_to": { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } }, @@ -67108,10 +67109,11 @@ { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } ], diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 301943fc91e5..538c87076778 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -69137,10 +69137,11 @@ "in_reply_to": { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } }, @@ -69283,10 +69284,11 @@ { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } ], diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 072e2db21921..129e0b1979ea 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -69233,16 +69233,16 @@ }, "position": { "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", + "description": "

Required without comfort-fade preview unless using in_reply_to. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, "side": { "type": "string", - "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", "enum": [ "LEFT", "RIGHT" @@ -69250,30 +69250,30 @@ "name": "side", "in": "body", "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "childParamsGroups": [] }, "line": { "type": "integer", - "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", "childParamsGroups": [] }, "start_line": { "type": "integer", - "description": "

Required when using multi-line comments. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", "rawType": "integer", - "rawDescription": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "childParamsGroups": [] }, "start_side": { "type": "string", - "description": "

Required when using multi-line comments. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", "enum": [ "LEFT", "RIGHT", @@ -69282,16 +69282,17 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, "in_reply_to": { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } }, @@ -69371,16 +69372,16 @@ }, { "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", + "description": "

Required without comfort-fade preview unless using in_reply_to. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, { "type": "string", - "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", "enum": [ "LEFT", "RIGHT" @@ -69388,30 +69389,30 @@ "name": "side", "in": "body", "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "childParamsGroups": [] }, { "type": "integer", - "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", "childParamsGroups": [] }, { "type": "integer", - "description": "

Required when using multi-line comments. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", "rawType": "integer", - "rawDescription": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "childParamsGroups": [] }, { "type": "string", - "description": "

Required when using multi-line comments. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", "enum": [ "LEFT", "RIGHT", @@ -69420,16 +69421,17 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } ], diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 29018f2e39c8..ed777f9bfd81 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -59622,16 +59622,16 @@ }, "position": { "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", + "description": "

Required without comfort-fade preview unless using in_reply_to. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, "side": { "type": "string", - "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", "enum": [ "LEFT", "RIGHT" @@ -59639,30 +59639,30 @@ "name": "side", "in": "body", "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "childParamsGroups": [] }, "line": { "type": "integer", - "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", "childParamsGroups": [] }, "start_line": { "type": "integer", - "description": "

Required when using multi-line comments. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", "rawType": "integer", - "rawDescription": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "childParamsGroups": [] }, "start_side": { "type": "string", - "description": "

Required when using multi-line comments. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", "enum": [ "LEFT", "RIGHT", @@ -59671,16 +59671,17 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, "in_reply_to": { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } }, @@ -59760,16 +59761,16 @@ }, { "type": "integer", - "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", + "description": "

Required without comfort-fade preview unless using in_reply_to. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

", "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, { "type": "string", - "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", "enum": [ "LEFT", "RIGHT" @@ -59777,30 +59778,30 @@ "name": "side", "in": "body", "rawType": "string", - "rawDescription": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "childParamsGroups": [] }, { "type": "integer", - "description": "

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", + "description": "

Required with comfort-fade preview unless using in_reply_to. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

", "name": "line", "in": "body", "rawType": "integer", - "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "rawDescription": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", "childParamsGroups": [] }, { "type": "integer", - "description": "

Required when using multi-line comments. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

", "name": "start_line", "in": "body", "rawType": "integer", - "rawDescription": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "childParamsGroups": [] }, { "type": "string", - "description": "

Required when using multi-line comments. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", + "description": "

Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", "enum": [ "LEFT", "RIGHT", @@ -59809,16 +59810,17 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, { "type": "integer", "example": 2, + "description": "

The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

", "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "rawDescription": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", "childParamsGroups": [] } ], diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index beb27bf74826..843aafb98d0e 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -323159,11 +323159,11 @@ }, "position": { "type": "integer", - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." }, "side": { "type": "string", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -323171,15 +323171,15 @@ }, "line": { "type": "integer", - "description": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." + "description": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -323188,7 +323188,8 @@ }, "in_reply_to": { "type": "integer", - "example": 2 + "example": 2, + "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored." } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 910004e34fc2..1450436f9fda 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -280279,7 +280279,8 @@ }, "in_reply_to": { "type": "integer", - "example": 2 + "example": 2, + "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored." } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index e7f7b0188050..860bc8a3fa0a 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -283875,7 +283875,8 @@ }, "in_reply_to": { "type": "integer", - "example": 2 + "example": 2, + "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored." } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 72744d3804ad..c457a6f95feb 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -290644,7 +290644,8 @@ }, "in_reply_to": { "type": "integer", - "example": 2 + "example": 2, + "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored." } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 4bb4a453b357..3e1328762715 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -297444,11 +297444,11 @@ }, "position": { "type": "integer", - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." }, "side": { "type": "string", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -297456,15 +297456,15 @@ }, "line": { "type": "integer", - "description": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." + "description": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -297473,7 +297473,8 @@ }, "in_reply_to": { "type": "integer", - "example": 2 + "example": 2, + "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored." } }, "required": [ diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 960cc6c3387d..0c517c1dc0e1 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -257436,11 +257436,11 @@ }, "position": { "type": "integer", - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "**Required without `comfort-fade` preview unless using `in_reply_to`**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." }, "side": { "type": "string", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "**Required with `comfort-fade` preview unless using `in_reply_to`**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -257448,15 +257448,15 @@ }, "line": { "type": "integer", - "description": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." + "description": "**Required with `comfort-fade` preview unless using `in_reply_to`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -257465,7 +257465,8 @@ }, "in_reply_to": { "type": "integer", - "example": 2 + "example": 2, + "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored." } }, "required": [