curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blockscurl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocksawait octokit.request('GET /orgs/{org}/blocks', {\n org: 'org'\n})\nawait octokit.request('GET /orgs/{org}/blocks', {\n org: 'org',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})\nThe API to block users is currently available for developers to preview. See the preview notice for more information.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.giant-sentry-fist-preview+jsoncurl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAMEcurl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAMEawait octokit.request('GET /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username'\n})\nawait octokit.request('GET /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})\nThe API to block users is currently available for developers to preview. See the preview notice for more information.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.giant-sentry-fist-preview+jsoncurl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAMEcurl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAMEawait octokit.request('PUT /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username'\n})\nawait octokit.request('PUT /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})\nThe API to block users is currently available for developers to preview. See the preview notice for more information.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.giant-sentry-fist-preview+jsoncurl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAMEcurl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAMEawait octokit.request('DELETE /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username'\n})\nawait octokit.request('DELETE /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})\nThe API to block users is currently available for developers to preview. See the preview notice for more information.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.giant-sentry-fist-preview+jsonGets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nAccess tokens must have the read:org scope.
Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nAccess tokens must have the repo or admin:org scope.
Gets the free and paid storage usued for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nAccess tokens must have the read:org scope.
Gets the free and paid storage usued for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nAccess tokens must have the repo or admin:org scope.
Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nAccess tokens must have the read:org scope.
Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nAccess tokens must have the repo or admin:org scope.
Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -60631,7 +60659,7 @@ } ], "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -60647,8 +60675,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Provides details for a review comment.
", "responses": [ { "httpStatusCode": "200", @@ -60729,7 +60757,7 @@ } ], "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -60771,8 +60799,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Enables you to edit a review comment.
", "bodyParameters": [ { "type": "string", @@ -61674,7 +61702,7 @@ } ], "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -61690,8 +61718,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -61766,7 +61794,7 @@ } ], "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -61912,8 +61940,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see the comfort-fade preview notice.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { "type": "string", @@ -78073,13 +78101,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks", - "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blockscurl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocksawait octokit.request('GET /user/blocks')\nawait octokit.request('GET /user/blocks', {\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})\nThe API to block users is currently available for developers to preview. See the preview notice for more information.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.giant-sentry-fist-preview+jsoncurl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAMEcurl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAMEawait octokit.request('GET /user/blocks/{username}', {\n username: 'username'\n})\nawait octokit.request('GET /user/blocks/{username}', {\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})\nThe API to block users is currently available for developers to preview. See the preview notice for more information.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.giant-sentry-fist-preview+jsonIf the user is blocked:
\nIf the user is not blocked:
" + "descriptionHTML": "" }, { "verb": "put", @@ -78239,13 +78281,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME", - "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAMEcurl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAMEawait octokit.request('PUT /user/blocks/{username}', {\n username: 'username'\n})\nawait octokit.request('PUT /user/blocks/{username}', {\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})\nThe API to block users is currently available for developers to preview. See the preview notice for more information.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.giant-sentry-fist-preview+jsoncurl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAMEcurl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAMEawait octokit.request('DELETE /user/blocks/{username}', {\n username: 'username'\n})\nawait octokit.request('DELETE /user/blocks/{username}', {\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})\nThe API to block users is currently available for developers to preview. See the preview notice for more information.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.giant-sentry-fist-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -44469,7 +44469,7 @@ } ], "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -44485,8 +44485,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Provides details for a review comment.
", "responses": [ { "httpStatusCode": "200", @@ -44567,7 +44567,7 @@ } ], "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -44609,8 +44609,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Enables you to edit a review comment.
", "bodyParameters": [ { "type": "string", @@ -45431,7 +45431,7 @@ } ], "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -45447,8 +45447,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -60104,11 +60104,6 @@ "httpStatusMessage": "Forbidden", "description": "Forbidden" }, - { - "httpStatusCode": "418", - "httpStatusMessage": "I'm A Teapot", - "description": "Response definition missing" - }, { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json index 953c6ba88a..86b3c26373 100644 --- a/lib/rest/static/decorated/ghes-2.19.json +++ b/lib/rest/static/decorated/ghes-2.19.json @@ -45172,7 +45172,7 @@ } ], "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -45188,8 +45188,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -45265,7 +45265,7 @@ } ], "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -45281,8 +45281,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Provides details for a review comment.
", "responses": [ { "httpStatusCode": "200", @@ -45363,7 +45363,7 @@ } ], "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -45405,8 +45405,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Enables you to edit a review comment.
", "bodyParameters": [ { "type": "string", @@ -46227,7 +46227,7 @@ } ], "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -46243,8 +46243,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -60688,11 +60688,6 @@ "httpStatusMessage": "Forbidden", "description": "Forbidden" }, - { - "httpStatusCode": "418", - "httpStatusMessage": "I'm A Teapot", - "description": "Response definition missing" - }, { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index d75ffcb7a9..5ed98b0890 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -45639,7 +45639,7 @@ } ], "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -45655,8 +45655,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -45732,7 +45732,7 @@ } ], "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -45748,8 +45748,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Provides details for a review comment.
", "responses": [ { "httpStatusCode": "200", @@ -45830,7 +45830,7 @@ } ], "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -45872,8 +45872,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Enables you to edit a review comment.
", "bodyParameters": [ { "type": "string", @@ -46694,7 +46694,7 @@ } ], "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -46710,8 +46710,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -46786,7 +46786,7 @@ } ], "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.20/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.20/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -46932,8 +46932,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see the comfort-fade preview notice.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { "type": "string", @@ -61244,11 +61244,6 @@ "httpStatusMessage": "Forbidden", "description": "Forbidden" }, - { - "httpStatusCode": "418", - "httpStatusMessage": "I'm A Teapot", - "description": "Response definition missing" - }, { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index eb371fa562..c140e52ad0 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -49462,7 +49462,7 @@ } ], "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -49478,8 +49478,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -49555,7 +49555,7 @@ } ], "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -49571,8 +49571,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Provides details for a review comment.
", "responses": [ { "httpStatusCode": "200", @@ -49653,7 +49653,7 @@ } ], "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -49695,8 +49695,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Enables you to edit a review comment.
", "bodyParameters": [ { "type": "string", @@ -50604,7 +50604,7 @@ } ], "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -50620,8 +50620,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -50696,7 +50696,7 @@ } ], "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.21/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.21/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -50842,8 +50842,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see the comfort-fade preview notice.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { "type": "string", @@ -65328,11 +65328,6 @@ "httpStatusMessage": "Forbidden", "description": "Forbidden" }, - { - "httpStatusCode": "418", - "httpStatusMessage": "I'm A Teapot", - "description": "Response definition missing" - }, { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index b4d19acad9..0af35c52df 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -56879,7 +56879,7 @@ } ], "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -56895,8 +56895,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -56972,7 +56972,7 @@ } ], "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -56988,8 +56988,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Provides details for a review comment.
", "responses": [ { "httpStatusCode": "200", @@ -57070,7 +57070,7 @@ } ], "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -57112,8 +57112,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Enables you to edit a review comment.
", "bodyParameters": [ { "type": "string", @@ -58015,7 +58015,7 @@ } ], "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -58031,8 +58031,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -58107,7 +58107,7 @@ } ], "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -58253,8 +58253,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see the comfort-fade preview notice.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { "type": "string", @@ -72691,11 +72691,6 @@ "httpStatusMessage": "Forbidden", "description": "Forbidden" }, - { - "httpStatusCode": "418", - "httpStatusMessage": "I'm A Teapot", - "description": "Response definition missing" - }, { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 4b169ad48b..396331a3cb 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -47139,7 +47139,7 @@ } ], "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -47155,8 +47155,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -47232,7 +47232,7 @@ } ], "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -47248,8 +47248,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Provides details for a review comment.
", "responses": [ { "httpStatusCode": "200", @@ -47330,7 +47330,7 @@ } ], "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -47372,8 +47372,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Enables you to edit a review comment.
", "bodyParameters": [ { "type": "string", @@ -48275,7 +48275,7 @@ } ], "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -48291,8 +48291,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
", "responses": [ { "httpStatusCode": "200", @@ -48367,7 +48367,7 @@ } ], "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/github-ae@latest/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/github-ae@latest/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -48513,8 +48513,8 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```", - "html": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonMulti-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the blog post for more information.
\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.comfort-fade-preview+jsonTo show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute.Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nMulti-line comment summary
\nNote: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
If you use the comfort-fade preview header, your response will show:
start_line, original_start_line, start_side, line, original_line, and side.line, original_line, and side and a null value for start_line, original_start_line, and start_side.If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
position attribute.position attribute. For more information, see position in the input parameters table.Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see the comfort-fade preview notice.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
", "bodyParameters": [ { "type": "string", @@ -61722,11 +61722,6 @@ "httpStatusMessage": "Forbidden", "description": "Forbidden" }, - { - "httpStatusCode": "418", - "httpStatusMessage": "I'm A Teapot", - "description": "Response definition missing" - }, { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 62710e6e25..985870788f 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -17853,31 +17853,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -35798,31 +35820,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -49798,7 +49842,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - + { + "required": true, + "name": "giant-sentry-fist", + "note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```" + } ], "category": "orgs", "subcategory": "blocking" @@ -49864,7 +49912,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - + { + "required": true, + "name": "giant-sentry-fist", + "note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```" + } ], "category": "orgs", "subcategory": "blocking" @@ -49977,7 +50029,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - + { + "required": true, + "name": "giant-sentry-fist", + "note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```" + } ], "category": "orgs", "subcategory": "blocking" @@ -50021,7 +50077,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - + { + "required": true, + "name": "giant-sentry-fist", + "note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```" + } ], "category": "orgs", "subcategory": "blocking" @@ -50561,31 +50621,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -69589,7 +69671,7 @@ "/orgs/{org}/settings/billing/actions": { "get": { "summary": "Get GitHub Actions billing for an organization", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `read:org` scope.", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", "operationId": "billing/get-github-actions-billing-org", "tags": [ "billing" @@ -69679,7 +69761,7 @@ "/orgs/{org}/settings/billing/packages": { "get": { "summary": "Get GitHub Packages billing for an organization", - "description": "Gets the free and paid storage usued for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `read:org` scope.", + "description": "Gets the free and paid storage usued for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", "operationId": "billing/get-github-packages-billing-org", "tags": [ "billing" @@ -69747,7 +69829,7 @@ "/orgs/{org}/settings/billing/shared-storage": { "get": { "summary": "Get shared storage billing for an organization", - "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `read:org` scope.", + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", "operationId": "billing/get-shared-storage-billing-org", "tags": [ "billing" @@ -148525,31 +148607,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -162786,31 +162890,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -170869,31 +170995,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -174048,31 +174196,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -182102,31 +182272,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -184341,31 +184533,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -188184,12 +188398,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -188371,12 +188586,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -188616,12 +188832,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -188920,12 +189137,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -191075,12 +191293,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -191255,12 +191474,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -191471,12 +191691,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -191636,12 +191857,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -194534,12 +194756,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -205258,7 +205481,7 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -205802,7 +206025,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -205818,7 +206041,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -206324,7 +206547,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -206338,7 +206561,7 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -206845,7 +207068,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -214163,7 +214386,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -214715,7 +214938,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -214729,7 +214952,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -215396,7 +215619,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -261444,7 +261667,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - + { + "required": true, + "name": "giant-sentry-fist", + "note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```" + } ], "category": "users", "subcategory": "blocking" @@ -261454,7 +261681,7 @@ "/user/blocks/{username}": { "get": { "summary": "Check if a user is blocked by the authenticated user", - "description": "If the user is blocked:\n\nIf the user is not blocked:", + "description": "", "tags": [ "users" ], @@ -261545,7 +261772,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - + { + "required": true, + "name": "giant-sentry-fist", + "note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```" + } ], "category": "users", "subcategory": "blocking" @@ -261713,7 +261944,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - + { + "required": true, + "name": "giant-sentry-fist", + "note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```" + } ], "category": "users", "subcategory": "blocking" @@ -261812,7 +262047,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [ - + { + "required": true, + "name": "giant-sentry-fist", + "note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```" + } ], "category": "users", "subcategory": "blocking" @@ -279688,9 +279927,6 @@ } } }, - "418": { - "description": "Response definition missing" - }, "422": { "description": "Validation Failed", "content": { @@ -287651,31 +287887,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -290345,31 +290603,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -293031,31 +293311,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -298462,31 +298764,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -301148,31 +301472,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json index f4adb36abf..376ede96c1 100644 --- a/lib/rest/static/dereferenced/ghes-2.18.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json @@ -15411,31 +15411,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -31010,31 +31032,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -37006,31 +37050,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -103613,31 +103679,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -115488,31 +115576,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -123444,31 +123554,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -126606,31 +126738,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -134604,31 +134758,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -136821,31 +136997,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -140637,12 +140835,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -140824,12 +141023,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -141069,12 +141269,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -141373,12 +141574,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -143464,12 +143666,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -143644,12 +143847,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -143860,12 +144064,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -146778,12 +146983,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -157844,7 +158050,7 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -158341,7 +158547,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -158357,7 +158563,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -158816,7 +159022,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -158830,7 +159036,7 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -159290,7 +159496,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -166545,7 +166751,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -167050,7 +167256,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -220351,9 +220557,6 @@ } } }, - "418": { - "description": "Response definition missing" - }, "422": { "description": "Validation Failed", "content": { @@ -228188,31 +228391,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -230855,31 +231080,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -233514,31 +233761,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -238912,31 +239181,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -241571,31 +241862,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json index 2a8e02c5c3..221e7b9331 100644 --- a/lib/rest/static/dereferenced/ghes-2.19.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json @@ -15431,31 +15431,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -31045,31 +31067,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -37051,31 +37095,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -106607,31 +106673,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -118664,31 +118752,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -126645,31 +126755,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -129812,31 +129944,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -137825,31 +137979,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -140047,31 +140223,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -143878,12 +144076,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -144065,12 +144264,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -144310,12 +144510,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -144614,12 +144815,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -146705,12 +146907,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -146885,12 +147088,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -147101,12 +147305,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -147266,12 +147471,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -150164,12 +150370,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -161221,7 +161428,7 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -161718,7 +161925,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -161734,7 +161941,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -162193,7 +162400,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -162207,7 +162414,7 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -162667,7 +162874,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -169922,7 +170129,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -170427,7 +170634,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -223558,9 +223765,6 @@ } } }, - "418": { - "description": "Response definition missing" - }, "422": { "description": "Validation Failed", "content": { @@ -231395,31 +231599,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -234072,31 +234298,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -236741,31 +236989,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -242149,31 +242419,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -244818,31 +245110,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { diff --git a/lib/rest/static/dereferenced/ghes-2.20.deref.json b/lib/rest/static/dereferenced/ghes-2.20.deref.json index 463a4e314c..90278f2e06 100644 --- a/lib/rest/static/dereferenced/ghes-2.20.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.20.deref.json @@ -17409,31 +17409,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -33079,31 +33101,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -39126,31 +39170,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -107803,31 +107869,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -119887,31 +119975,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -127884,31 +127994,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -131059,31 +131191,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -139096,31 +139250,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -141326,31 +141502,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -145165,12 +145363,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -145352,12 +145551,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -145597,12 +145797,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -145901,12 +146102,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -147992,12 +148194,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -148172,12 +148375,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -148388,12 +148592,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -148553,12 +148758,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -151451,12 +151657,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -162529,7 +162736,7 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -163073,7 +163280,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -163089,7 +163296,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -163595,7 +163802,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -163609,7 +163816,7 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -164116,7 +164323,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -171371,7 +171578,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -171923,7 +172130,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -171937,7 +172144,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.20/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.20/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -172604,7 +172811,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -225563,9 +225770,6 @@ } } }, - "418": { - "description": "Response definition missing" - }, "422": { "description": "Validation Failed", "content": { @@ -233446,31 +233650,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -236131,31 +236357,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -238808,31 +239056,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -244224,31 +244494,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -246901,31 +247193,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { diff --git a/lib/rest/static/dereferenced/ghes-2.21.deref.json b/lib/rest/static/dereferenced/ghes-2.21.deref.json index 6ab6066fbe..adadce9378 100644 --- a/lib/rest/static/dereferenced/ghes-2.21.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.21.deref.json @@ -17414,31 +17414,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -33113,31 +33135,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -39175,31 +39219,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -117040,31 +117106,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -129153,31 +129241,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -137235,31 +137345,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -140419,31 +140551,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -148483,31 +148637,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -150722,31 +150898,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -154570,12 +154768,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -154757,12 +154956,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -155002,12 +155202,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -155306,12 +155507,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -157464,12 +157666,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -157644,12 +157847,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -157860,12 +158064,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -158025,12 +158230,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -160923,12 +161129,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -172014,7 +172221,7 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -172558,7 +172765,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -172574,7 +172781,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -173080,7 +173287,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -173094,7 +173301,7 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -173601,7 +173808,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -180918,7 +181125,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -181470,7 +181677,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -181484,7 +181691,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.21/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.21/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -182151,7 +182358,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -232820,9 +233027,6 @@ } } }, - "418": { - "description": "Response definition missing" - }, "422": { "description": "Validation Failed", "content": { @@ -240740,31 +240944,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -243434,31 +243660,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -246120,31 +246368,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -251545,31 +251815,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -254231,31 +254523,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index 684509ecfa..1999a5cf8c 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -21048,31 +21048,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -36848,31 +36870,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -48887,31 +48931,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -138223,31 +138289,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -150324,31 +150412,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -158407,31 +158517,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -161586,31 +161718,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -169640,31 +169794,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -171879,31 +172055,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -175722,12 +175920,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -175909,12 +176108,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -176154,12 +176354,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -176458,12 +176659,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -178613,12 +178815,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -178793,12 +178996,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -179009,12 +179213,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -179174,12 +179379,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -182072,12 +182278,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -193181,7 +193388,7 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -193725,7 +193932,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -193741,7 +193948,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -194247,7 +194454,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -194261,7 +194468,7 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -194768,7 +194975,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -202086,7 +202293,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -202638,7 +202845,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -202652,7 +202859,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.22/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -203319,7 +203526,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -254017,9 +254224,6 @@ } } }, - "418": { - "description": "Response definition missing" - }, "422": { "description": "Validation Failed", "content": { @@ -261970,31 +262174,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -264664,31 +264890,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -267350,31 +267598,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -272762,31 +273032,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -275448,31 +275740,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index d64958271e..0f5816e5b1 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -11475,31 +11475,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -27338,31 +27360,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -33420,31 +33464,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -111193,31 +111259,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -123541,31 +123629,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -131624,31 +131734,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -134803,31 +134935,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -142857,31 +143011,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -145096,31 +145272,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -148939,12 +149137,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -149126,12 +149325,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -149371,12 +149571,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -149675,12 +149876,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -151830,12 +152032,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -152010,12 +152213,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -152226,12 +152430,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -152391,12 +152596,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] }, "examples": { @@ -155289,12 +155495,13 @@ } }, "required": [ - "color", - "name", "id", "node_id", - "default", - "url" + "url", + "name", + "description", + "color", + "default" ] } }, @@ -166013,7 +166220,7 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -166557,7 +166764,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -166573,7 +166780,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "description": "Provides details for a review comment.", "tags": [ "pulls" ], @@ -167079,7 +167286,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -167093,7 +167300,7 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.", + "description": "Enables you to edit a review comment.", "tags": [ "pulls" ], @@ -167600,7 +167807,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -174918,7 +175125,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "tags": [ "pulls" ], @@ -175470,7 +175677,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." }, { "required": false, @@ -175484,7 +175691,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/github-ae@latest/rest/reference/pulls#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/github-ae@latest/rest/reference/pulls#parameters-2) table.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/github-ae@latest/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -176151,7 +176358,7 @@ { "required": false, "name": "comfort-fade", - "note": "Multi-line comments in a pull request diff is currently available for developers to preview. To access the new response fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```" + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." } ], "category": "pulls", @@ -224769,9 +224976,6 @@ } } }, - "418": { - "description": "Response definition missing" - }, "422": { "description": "Validation Failed", "content": { @@ -232732,31 +232936,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -235426,31 +235652,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -238112,31 +238360,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -243543,31 +243813,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": { @@ -246229,31 +246521,53 @@ "labels": { "type": "array", "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "example": 208045946 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { - "type": "string" + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" }, "name": { + "description": "The name of the label.", + "example": "bug", "type": "string" }, "description": { "type": "string", + "example": "Something isn't working", "nullable": true }, "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", "type": "string" }, "default": { - "type": "boolean" + "type": "boolean", + "example": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] } }, "assignee": {