Update OpenAPI Descriptions
This commit is contained in:
github-openapi-bot
committed by
GitHub
GitHub
parent
7ddf222f42
commit
01808cf493
@@ -71284,16 +71284,16 @@
|
||||
},
|
||||
"position": {
|
||||
"type": "integer",
|
||||
"description": "<p>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.</p>",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. 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.</p>",
|
||||
"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": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> 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 \"<a href=\"https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> 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 \"<a href=\"https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. 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.</p>",
|
||||
"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": "<p><strong>Required when using multi-line comments</strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"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": "<p><strong>Required when using multi-line comments</strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"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": "<p>The ID of the review comment to reply to. To find the ID of a review comment with <a href=\"#list-review-comments-on-a-pull-request\">\"List review comments on a pull request\"</a>. When specified, all parameters other than <code>body</code> in the request body are ignored.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"description": "<p><strong>Required without <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. 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.</p>",
|
||||
"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": "<p>In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> 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 \"<a href=\"https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. In a split diff view, the side of the diff that the pull request's changes appear on. Can be <code>LEFT</code> or <code>RIGHT</code>. Use <code>LEFT</code> for deletions that appear in red. Use <code>RIGHT</code> 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 \"<a href=\"https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options\">Diff view options</a>\" in the GitHub Help documentation.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"description": "<p><strong>Required with <code>comfort-fade</code> preview unless using <code>in_reply_to</code></strong>. 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.</p>",
|
||||
"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": "<p><strong>Required when using multi-line comments</strong>. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_line</code> is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"<a href=\"https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation.</p>",
|
||||
"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": "<p><strong>Required when using multi-line comments</strong>. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"description": "<p><strong>Required when using multi-line comments unless using <code>in_reply_to</code></strong>. To create multi-line comments, you must use the <code>comfort-fade</code> preview header. The <code>start_side</code> is the starting side of the diff that the comment applies to. Can be <code>LEFT</code> or <code>RIGHT</code>. To learn more about multi-line comments, see \"<a href=\"https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request\">Commenting on a pull request</a>\" in the GitHub Help documentation. See <code>side</code> in this table for additional context.</p>",
|
||||
"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": "<p>The ID of the review comment to reply to. To find the ID of a review comment with <a href=\"#list-review-comments-on-a-pull-request\">\"List review comments on a pull request\"</a>. When specified, all parameters other than <code>body</code> in the request body are ignored.</p>",
|
||||
"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": []
|
||||
}
|
||||
],
|
||||
|
||||
Reference in New Issue
Block a user