From 6023c80c2c4b8b6ad7aac9ce6e5e6cc12a4b46d8 Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Tue, 26 Oct 2021 10:39:18 -0700 Subject: [PATCH 1/2] Update OpenAPI Descriptions --- .../dereferenced/api.github.com.deref.json | 213 ++-------- .../static/dereferenced/ghes-3.0.deref.json | 382 ++++++++++-------- .../static/dereferenced/ghes-3.1.deref.json | 382 ++++++++++-------- .../static/dereferenced/ghes-3.2.deref.json | 382 ++++++++++-------- .../static/dereferenced/github.ae.deref.json | 345 +++------------- 5 files changed, 719 insertions(+), 985 deletions(-) diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 1b1783436fe5..30fc513d497c 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -37044,13 +37044,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" - } - ], "category": "apps", "subcategory": "installations" } @@ -61933,15 +61926,6 @@ "type": "integer", "default": 30 } - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -183787,18 +183771,10 @@ "type": "string" }, "user": { - "title": "Simple User", - "description": "Simple User", + "title": "Collaborator", + "description": "Collaborator", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, "login": { "type": "string", "example": "octocat" @@ -183807,6 +183783,14 @@ "type": "integer", "example": 1 }, + "email": { + "nullable": true, + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -183879,9 +183863,30 @@ "site_admin": { "type": "boolean" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] } }, "required": [ @@ -300765,13 +300770,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } @@ -301306,13 +301304,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } @@ -301841,13 +301832,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } @@ -310147,20 +310131,13 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } }, "post": { "summary": "Create a review comment for a pull request", - "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "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.\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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -310216,11 +310193,11 @@ }, "position": { "type": "integer", - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." }, "side": { "type": "string", - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -310228,15 +310205,15 @@ }, "line": { "type": "integer", - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." + "description": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -310847,13 +310824,6 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } @@ -335338,28 +335308,6 @@ } } }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -335390,13 +335338,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" - } - ], "category": "repos", "subcategory": null } @@ -335496,28 +335437,6 @@ } } }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -335578,13 +335497,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" - } - ], "category": "repos", "subcategory": null } @@ -354700,7 +354612,7 @@ "/search/repositories": { "get": { "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "tags": [ "search" ], @@ -355593,13 +355505,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" - } - ], "category": "search", "subcategory": null } @@ -355923,40 +355828,11 @@ }, "304": { "description": "Not modified" - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" - } - ], "category": "search", "subcategory": null } @@ -376915,13 +376791,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" - } - ], "category": "apps", "subcategory": "installations" } diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 6f61d82325b1..74b65050fccd 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -510,15 +510,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } }, "post": { @@ -532,18 +532,6 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#create-a-global-webhook" }, - "parameters": [ - { - "name": "accept", - "description": "This API is under preview and subject to change.", - "in": "header", - "schema": { - "type": "string", - "default": "application/vnd.github.superpro-preview+json" - }, - "required": true - } - ], "responses": { "201": { "description": "Response", @@ -701,16 +689,28 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" - } + ] + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.superpro-preview+json" + }, + "required": true + } + ] } }, "/admin/hooks/{hook_id}": { @@ -833,15 +833,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } }, "patch": { @@ -1014,15 +1014,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } }, "delete": { @@ -1064,15 +1064,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } } }, @@ -1116,15 +1116,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } } }, @@ -2326,15 +2326,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } }, "post": { @@ -2456,15 +2456,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -2570,15 +2570,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } }, "patch": { @@ -2747,15 +2747,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } }, "delete": { @@ -2833,15 +2833,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -2954,15 +2954,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -3029,15 +3029,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -3237,15 +3237,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } }, "post": { @@ -3449,15 +3449,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } } }, @@ -3614,15 +3614,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } }, "patch": { @@ -3825,15 +3825,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } }, "delete": { @@ -3866,15 +3866,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } } }, @@ -43556,15 +43556,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "apps", - "subcategory": "installations" + ] } } }, @@ -76703,15 +76703,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } } }, @@ -76789,15 +76789,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } }, "patch": { @@ -76896,15 +76896,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } }, "delete": { @@ -76980,15 +76980,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } } }, @@ -159648,18 +159648,10 @@ "type": "string" }, "user": { - "title": "Simple User", - "description": "Simple User", + "title": "Collaborator", + "description": "Collaborator", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, "login": { "type": "string", "example": "octocat" @@ -159668,6 +159660,14 @@ "type": "integer", "example": 1 }, + "email": { + "nullable": true, + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -159740,9 +159740,30 @@ "site_admin": { "type": "boolean" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] } }, "required": [ @@ -261490,15 +261511,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } } }, @@ -261580,15 +261601,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } }, "patch": { @@ -261691,15 +261712,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } }, "delete": { @@ -261779,15 +261800,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } } }, @@ -270955,15 +270976,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.0/rest/reference/reactions) reactions." + }, + { + "required": false, + "name": "comfort-fade", + "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@3.0/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", - "subcategory": "comments" + ] } } }, @@ -271496,15 +271522,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.0/rest/reference/reactions) reactions." + }, + { + "required": false, + "name": "comfort-fade", + "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@3.0/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", - "subcategory": "comments" + ] } }, "patch": { @@ -272031,15 +272062,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "comfort-fade", "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@3.0/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", - "subcategory": "comments" + ] } }, "delete": { @@ -280051,15 +280082,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.0/rest/reference/reactions) reactions." + }, + { + "required": false, + "name": "comfort-fade", + "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@3.0/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", - "subcategory": "comments" + ] } }, "post": { @@ -280751,15 +280787,15 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "comfort-fade", "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@3.0/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", - "subcategory": "comments" + ] } } }, @@ -303101,48 +303137,48 @@ } } }, - "415": { - "description": "Preview header missing", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "404": { - "description": "Resource not found", + "415": { + "description": "Preview header missing", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" } } } @@ -303153,15 +303189,14 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "repos", - "subcategory": null + ] } }, "put": { @@ -303259,28 +303294,6 @@ } } }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -303336,20 +303349,41 @@ } } } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "repos", - "subcategory": null + ] } } }, @@ -316647,15 +316681,14 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "search", - "subcategory": null + ] } } }, @@ -317004,15 +317037,14 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": true, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "search", - "subcategory": null + ] } } }, @@ -337591,15 +337623,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "apps", - "subcategory": "installations" + ] } } }, diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index a00f463d799f..026a691abcf2 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -510,15 +510,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } }, "post": { @@ -532,18 +532,6 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#create-a-global-webhook" }, - "parameters": [ - { - "name": "accept", - "description": "This API is under preview and subject to change.", - "in": "header", - "schema": { - "type": "string", - "default": "application/vnd.github.superpro-preview+json" - }, - "required": true - } - ], "responses": { "201": { "description": "Response", @@ -701,16 +689,28 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" - } + ] + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.superpro-preview+json" + }, + "required": true + } + ] } }, "/admin/hooks/{hook_id}": { @@ -833,15 +833,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } }, "patch": { @@ -1014,15 +1014,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } }, "delete": { @@ -1064,15 +1064,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } } }, @@ -1116,15 +1116,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } } }, @@ -2326,15 +2326,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } }, "post": { @@ -2456,15 +2456,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -2570,15 +2570,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } }, "patch": { @@ -2747,15 +2747,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } }, "delete": { @@ -2833,15 +2833,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -2954,15 +2954,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -3029,15 +3029,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -3237,15 +3237,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } }, "post": { @@ -3449,15 +3449,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } } }, @@ -3614,15 +3614,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } }, "patch": { @@ -3825,15 +3825,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } }, "delete": { @@ -3866,15 +3866,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } } }, @@ -43581,15 +43581,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "apps", - "subcategory": "installations" + ] } } }, @@ -77020,15 +77020,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } } }, @@ -77106,15 +77106,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } }, "patch": { @@ -77213,15 +77213,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } }, "delete": { @@ -77297,15 +77297,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } } }, @@ -162455,18 +162455,10 @@ "type": "string" }, "user": { - "title": "Simple User", - "description": "Simple User", + "title": "Collaborator", + "description": "Collaborator", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, "login": { "type": "string", "example": "octocat" @@ -162475,6 +162467,14 @@ "type": "integer", "example": 1 }, + "email": { + "nullable": true, + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -162547,9 +162547,30 @@ "site_admin": { "type": "boolean" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] } }, "required": [ @@ -264450,15 +264471,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } } }, @@ -264540,15 +264561,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } }, "patch": { @@ -264651,15 +264672,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } }, "delete": { @@ -264739,15 +264760,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } } }, @@ -274220,15 +274241,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.1/rest/reference/reactions) reactions." + }, + { + "required": false, + "name": "comfort-fade", + "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@3.1/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", - "subcategory": "comments" + ] } } }, @@ -274761,15 +274787,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.1/rest/reference/reactions) reactions." + }, + { + "required": false, + "name": "comfort-fade", + "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@3.1/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", - "subcategory": "comments" + ] } }, "patch": { @@ -275296,15 +275327,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "comfort-fade", "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@3.1/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", - "subcategory": "comments" + ] } }, "delete": { @@ -283620,15 +283651,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.1/rest/reference/reactions) reactions." + }, + { + "required": false, + "name": "comfort-fade", + "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@3.1/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", - "subcategory": "comments" + ] } }, "post": { @@ -284320,15 +284356,15 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "comfort-fade", "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@3.1/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", - "subcategory": "comments" + ] } } }, @@ -307976,48 +308012,48 @@ } } }, - "415": { - "description": "Preview header missing", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "404": { - "description": "Resource not found", + "415": { + "description": "Preview header missing", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" } } } @@ -308028,15 +308064,14 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "repos", - "subcategory": null + ] } }, "put": { @@ -308134,28 +308169,6 @@ } } }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -308211,20 +308224,41 @@ } } } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "repos", - "subcategory": null + ] } } }, @@ -321522,15 +321556,14 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "search", - "subcategory": null + ] } } }, @@ -321879,15 +321912,14 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": true, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "search", - "subcategory": null + ] } } }, @@ -342480,15 +342512,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "apps", - "subcategory": "installations" + ] } } }, diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 83be1c58281a..3bf1a6ccdf75 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -510,15 +510,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } }, "post": { @@ -532,18 +532,6 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#create-a-global-webhook" }, - "parameters": [ - { - "name": "accept", - "description": "This API is under preview and subject to change.", - "in": "header", - "schema": { - "type": "string", - "default": "application/vnd.github.superpro-preview+json" - }, - "required": true - } - ], "responses": { "201": { "description": "Response", @@ -701,16 +689,28 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" - } + ] + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.superpro-preview+json" + }, + "required": true + } + ] } }, "/admin/hooks/{hook_id}": { @@ -833,15 +833,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } }, "patch": { @@ -1014,15 +1014,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } }, "delete": { @@ -1064,15 +1064,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } } }, @@ -1116,15 +1116,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, "name": "superpro", "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] } } }, @@ -2326,15 +2326,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } }, "post": { @@ -2456,15 +2456,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -2570,15 +2570,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } }, "patch": { @@ -2747,15 +2747,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } }, "delete": { @@ -2833,15 +2833,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -2954,15 +2954,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -3029,15 +3029,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] } } }, @@ -3237,15 +3237,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } }, "post": { @@ -3449,15 +3449,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } } }, @@ -3614,15 +3614,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } }, "patch": { @@ -3825,15 +3825,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } }, "delete": { @@ -3866,15 +3866,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] } } }, @@ -44527,15 +44527,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "apps", - "subcategory": "installations" + ] } } }, @@ -78957,15 +78957,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } } }, @@ -79043,15 +79043,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } }, "patch": { @@ -79150,15 +79150,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } }, "delete": { @@ -79234,15 +79234,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] } } }, @@ -166154,18 +166154,10 @@ "type": "string" }, "user": { - "title": "Simple User", - "description": "Simple User", + "title": "Collaborator", + "description": "Collaborator", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, "login": { "type": "string", "example": "octocat" @@ -166174,6 +166166,14 @@ "type": "integer", "example": 1 }, + "email": { + "nullable": true, + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -166246,9 +166246,30 @@ "site_admin": { "type": "boolean" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] } }, "required": [ @@ -271202,15 +271223,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } } }, @@ -271292,15 +271313,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } }, "patch": { @@ -271403,15 +271424,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } }, "delete": { @@ -271491,15 +271512,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, "name": "eye-scream", "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] } } }, @@ -280992,15 +281013,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.2/rest/reference/reactions) reactions." + }, + { + "required": false, + "name": "comfort-fade", + "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@3.2/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", - "subcategory": "comments" + ] } } }, @@ -281533,15 +281559,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.2/rest/reference/reactions) reactions." + }, + { + "required": false, + "name": "comfort-fade", + "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@3.2/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", - "subcategory": "comments" + ] } }, "patch": { @@ -282068,15 +282099,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "comfort-fade", "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@3.2/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", - "subcategory": "comments" + ] } }, "delete": { @@ -290392,15 +290423,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.2/rest/reference/reactions) reactions." + }, + { + "required": false, + "name": "comfort-fade", + "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@3.2/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", - "subcategory": "comments" + ] } }, "post": { @@ -291092,15 +291128,15 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "comfort-fade", "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@3.2/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", - "subcategory": "comments" + ] } } }, @@ -315361,48 +315397,48 @@ } } }, - "415": { - "description": "Preview header missing", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "404": { - "description": "Resource not found", + "415": { + "description": "Preview header missing", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" } } } @@ -315413,15 +315449,14 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "repos", - "subcategory": null + ] } }, "put": { @@ -315519,28 +315554,6 @@ } } }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -315596,20 +315609,41 @@ } } } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "repos", - "subcategory": null + ] } } }, @@ -329430,15 +329464,14 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "search", - "subcategory": null + ] } } }, @@ -329787,15 +329820,14 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": true, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "search", - "subcategory": null + ] } } }, @@ -350427,15 +350459,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, "name": "mercy", "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" } - ], - "category": "apps", - "subcategory": "installations" + ] } } }, diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index be749799977f..f56b2a646178 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -506,13 +506,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" } @@ -528,18 +521,6 @@ "description": "API method documentation", "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#create-a-global-webhook" }, - "parameters": [ - { - "name": "accept", - "description": "This API is under preview and subject to change.", - "in": "header", - "schema": { - "type": "string", - "default": "application/vnd.github.superpro-preview+json" - }, - "required": true - } - ], "responses": { "201": { "description": "Response", @@ -697,13 +678,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" } @@ -722,16 +696,6 @@ "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-global-webhook" }, "parameters": [ - { - "name": "accept", - "description": "This API is under preview and subject to change.", - "in": "header", - "schema": { - "type": "string", - "default": "application/vnd.github.superpro-preview+json" - }, - "required": true - }, { "name": "hook_id", "in": "path", @@ -829,13 +793,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" } @@ -852,16 +809,6 @@ "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-a-global-webhook" }, "parameters": [ - { - "name": "accept", - "description": "This API is under preview and subject to change.", - "in": "header", - "schema": { - "type": "string", - "default": "application/vnd.github.superpro-preview+json" - }, - "required": true - }, { "name": "hook_id", "in": "path", @@ -1010,13 +957,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" } @@ -1060,13 +1000,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" } @@ -1112,13 +1045,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" } @@ -1728,13 +1654,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" } @@ -1858,13 +1777,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" } @@ -1972,13 +1884,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" } @@ -2149,13 +2054,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" } @@ -2235,13 +2133,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" } @@ -2356,13 +2247,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" } @@ -2431,13 +2315,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" } @@ -28439,13 +28316,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```" - } - ], "category": "apps", "subcategory": "installations" } @@ -135724,18 +135594,10 @@ "type": "string" }, "user": { - "title": "Simple User", - "description": "Simple User", + "title": "Collaborator", + "description": "Collaborator", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, "login": { "type": "string", "example": "octocat" @@ -135744,6 +135606,14 @@ "type": "integer", "example": 1 }, + "email": { + "nullable": true, + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -135816,9 +135686,30 @@ "site_admin": { "type": "boolean" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] } }, "required": [ @@ -237296,7 +237187,14 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "pages" + "subcategory": "pages", + "previews": [ + { + "required": true, + "name": "switcheroo", + "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints 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.switcheroo-preview+json\n```" + } + ] } }, "put": { @@ -237691,7 +237589,14 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "pages" + "subcategory": "pages", + "previews": [ + { + "required": true, + "name": "machine-man", + "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```" + } + ] } } }, @@ -248040,13 +247945,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } @@ -248581,13 +248479,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } @@ -249116,13 +249007,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } @@ -257422,20 +257306,13 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } }, "post": { "summary": "Create a review comment for a pull request", - "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "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.\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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -257491,11 +257368,11 @@ }, "position": { "type": "integer", - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." }, "side": { "type": "string", - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -257503,15 +257380,15 @@ }, "line": { "type": "integer", - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." + "description": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -258122,13 +257999,6 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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", "subcategory": "comments" } @@ -282409,28 +282279,6 @@ } } }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -282461,13 +282309,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```" - } - ], "category": "repos", "subcategory": null } @@ -282567,28 +282408,6 @@ } } }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource not found", "content": { @@ -282649,13 +282468,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```" - } - ], "category": "repos", "subcategory": null } @@ -294234,7 +294046,7 @@ "/search/repositories": { "get": { "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "tags": [ "search" ], @@ -295127,13 +294939,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```" - } - ], "category": "search", "subcategory": null } @@ -295457,40 +295262,11 @@ }, "304": { "description": "Not modified" - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```" - } - ], "category": "search", "subcategory": null } @@ -314084,13 +313860,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```" - } - ], "category": "apps", "subcategory": "installations" } From e15fb03fc06a80c8a355c19ba498ebfb8180e0c5 Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Tue, 26 Oct 2021 17:45:15 +0000 Subject: [PATCH 2/2] Add decorated OpenAPI schema files --- lib/rest/static/decorated/api.github.com.json | 185 ++----- lib/rest/static/decorated/ghes-3.0.json | 236 ++++----- lib/rest/static/decorated/ghes-3.1.json | 236 ++++----- lib/rest/static/decorated/ghes-3.2.json | 236 ++++----- lib/rest/static/decorated/github.ae.json | 455 +++++------------- 5 files changed, 526 insertions(+), 822 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index d37d8f2cafc3..a4dd8d275b26 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -11614,14 +11614,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "apps", "subcategory": "installations" }, @@ -17618,16 +17610,6 @@ "default": 30 }, "descriptionHTML": "

Results per page (max 100)

" - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - }, - "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ @@ -69239,14 +69221,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -69326,14 +69300,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -69445,14 +69411,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -70333,14 +70291,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -70407,7 +70357,7 @@ } ], "summary": "Create a review comment for a pull request", - "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "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.\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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -70452,16 +70402,16 @@ }, "position": { "type": "integer", - "description": "

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

", "enum": [ "LEFT", "RIGHT", @@ -70501,7 +70451,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, "in_reply_to": { @@ -70549,14 +70499,6 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -70567,7 +70509,7 @@ "subcategoryLabel": "Comments", "contentType": "application/json", "notes": [], - "descriptionHTML": "

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.

\n

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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

", + "descriptionHTML": "

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.

\n

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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -70598,16 +70540,16 @@ }, { "type": "integer", - "description": "

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

", "enum": [ "LEFT", "RIGHT", @@ -70647,7 +70589,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, { @@ -76848,13 +76790,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/topics', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  mediaType: {\n    previews: [\n      'mercy'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/topics', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], "summary": "Get all repository topics", @@ -76870,14 +76812,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "repos", "subcategory": null }, @@ -76898,11 +76832,6 @@ "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" } ] }, @@ -76933,13 +76862,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n names: [\n 'names'\n ],\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  names: [\n    'names'\n  ],\n  mediaType: {\n    previews: [\n      'mercy'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n names: [\n 'names'\n ]\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  names: [\n    'names'\n  ]\n})\n
" } ], "summary": "Replace all repository topics", @@ -76990,14 +76919,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "repos", "subcategory": null }, @@ -77033,11 +76954,6 @@ "httpStatusMessage": "Not Found", "description": "Resource not found" }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", @@ -83375,7 +83291,7 @@ } ], "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "tags": [ "search" ], @@ -83387,14 +83303,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "search", "subcategory": null }, @@ -83403,7 +83311,7 @@ "categoryLabel": "Search", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Find repositories via various criteria. This method returns up to 100 results per page.

\n

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\n

q=tetris+language:assembly&sort=stars&order=desc

\n

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

\n

When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:

\n

q=topic:ruby+topic:rails

", + "descriptionHTML": "

Find repositories via various criteria. This method returns up to 100 results per page.

\n

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\n

q=tetris+language:assembly&sort=stars&order=desc

\n

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

", "responses": [ { "httpStatusCode": "200", @@ -83467,13 +83375,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://api.github.com/search/topics
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/topics", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/search/topics
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /search/topics', {\n q: 'q',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})", - "html": "
await octokit.request('GET /search/topics', {\n  q: 'q',\n  mediaType: {\n    previews: [\n      'mercy'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /search/topics', {\n q: 'q'\n})", + "html": "
await octokit.request('GET /search/topics', {\n  q: 'q'\n})\n
" } ], "summary": "Search topics", @@ -83489,14 +83397,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "search", "subcategory": null }, @@ -83517,11 +83417,6 @@ "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" } ] }, @@ -89571,14 +89466,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "apps", "subcategory": "installations" }, diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index fc4e2339e778..5de19fabfb25 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -107,6 +107,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -114,9 +116,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "list-global-webhooks", "category": "enterprise-admin", @@ -330,6 +330,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -337,9 +339,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "create-a-global-webhook", "category": "enterprise-admin", @@ -536,6 +536,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -543,9 +545,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "get-a-global-webhook", "category": "enterprise-admin", @@ -750,6 +750,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -757,9 +759,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "update-a-global-webhook", "category": "enterprise-admin", @@ -947,6 +947,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -954,9 +956,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "delete-a-global-webhook", "category": "enterprise-admin", @@ -1025,6 +1025,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -1032,9 +1034,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "ping-a-global-webhook", "category": "enterprise-admin", @@ -1852,6 +1852,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -1859,9 +1861,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "list-pre-receive-environments", "category": "enterprise-admin", @@ -1948,6 +1948,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -1955,9 +1957,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "create-a-pre-receive-environment", "category": "enterprise-admin", @@ -2036,6 +2036,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2043,9 +2045,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "get-a-pre-receive-environment", "category": "enterprise-admin", @@ -2133,6 +2133,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2140,9 +2142,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "update-a-pre-receive-environment", "category": "enterprise-admin", @@ -2227,6 +2227,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2234,9 +2236,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "delete-a-pre-receive-environment", "category": "enterprise-admin", @@ -2300,6 +2300,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2307,9 +2309,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "start-a-pre-receive-environment-download", "category": "enterprise-admin", @@ -2374,6 +2374,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2381,9 +2383,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "get-the-download-status-for-a-pre-receive-environment", "category": "enterprise-admin", @@ -2484,6 +2484,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2491,9 +2493,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "list-pre-receive-hooks", "category": "enterprise-admin", @@ -2630,6 +2630,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2637,9 +2639,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "create-a-pre-receive-hook", "category": "enterprise-admin", @@ -2759,6 +2759,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2766,9 +2768,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "get-a-pre-receive-hook", "category": "enterprise-admin", @@ -2904,6 +2904,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2911,9 +2913,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "update-a-pre-receive-hook", "category": "enterprise-admin", @@ -3033,6 +3033,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -3040,9 +3042,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "delete-a-pre-receive-hook", "category": "enterprise-admin", @@ -15706,6 +15706,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, @@ -15713,9 +15715,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "apps", - "subcategory": "installations" + ] }, "slug": "list-repositories-accessible-to-the-app-installation", "category": "apps", @@ -23792,6 +23792,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -23799,9 +23801,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "list-pre-receive-hooks-for-an-organization", "category": "enterprise-admin", @@ -23870,6 +23870,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -23877,9 +23879,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "get-a-pre-receive-hook-for-an-organization", "category": "enterprise-admin", @@ -23981,6 +23981,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -23988,9 +23990,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "update-pre-receive-hook-enforcement-for-an-organization", "category": "enterprise-admin", @@ -24079,6 +24079,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -24086,9 +24088,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "remove-pre-receive-hook-enforcement-for-an-organization", "category": "enterprise-admin", @@ -63775,6 +63775,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -63782,9 +63784,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "list-pre-receive-hooks-for-a-repository", "category": "enterprise-admin", @@ -63862,6 +63862,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -63869,9 +63871,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "get-a-pre-receive-hook-for-a-repository", "category": "enterprise-admin", @@ -63977,6 +63977,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -63984,9 +63986,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "update-pre-receive-hook-enforcement-for-a-repository", "category": "enterprise-admin", @@ -64080,6 +64080,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -64087,9 +64089,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "remove-pre-receive-hook-enforcement-for-a-repository", "category": "enterprise-admin", @@ -64899,16 +64899,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.0/rest/reference/reactions) reactions.", "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + }, + { + "required": false, + "name": "comfort-fade", + "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@3.0/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.", + "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "list-review-comments-in-a-repository", "category": "pulls", @@ -64986,16 +64992,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.0/rest/reference/reactions) reactions.", "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + }, + { + "required": false, + "name": "comfort-fade", + "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@3.0/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.", + "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "get-a-review-comment-for-a-pull-request", "category": "pulls", @@ -65105,6 +65117,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, @@ -65112,9 +65126,7 @@ "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@3.0/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.", "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "update-a-review-comment-for-a-pull-request", "category": "pulls", @@ -66014,16 +66026,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.0/rest/reference/reactions) reactions.", "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + }, + { + "required": false, + "name": "comfort-fade", + "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@3.0/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.", + "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "list-review-comments-on-a-pull-request", "category": "pulls", @@ -66230,6 +66248,8 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, @@ -66237,9 +66257,7 @@ "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@3.0/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.", "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "create-a-review-comment-for-a-pull-request", "category": "pulls", @@ -71779,6 +71797,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, @@ -71786,9 +71805,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "repos", - "subcategory": null + ] }, "slug": "get-all-repository-topics", "category": "repos", @@ -71899,6 +71916,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, @@ -71906,9 +71924,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "repos", - "subcategory": null + ] }, "slug": "replace-all-repository-topics", "category": "repos", @@ -73055,6 +73071,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": false, @@ -73062,9 +73079,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "search", - "subcategory": null + ] }, "slug": "search-repositories", "category": "search", @@ -73157,6 +73172,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": true, @@ -73164,9 +73180,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "search", - "subcategory": null + ] }, "slug": "search-topics", "category": "search", @@ -79173,6 +79187,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, @@ -79180,9 +79196,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "apps", - "subcategory": "installations" + ] }, "slug": "list-repositories-accessible-to-the-user-access-token", "category": "apps", diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 084af1338f8d..1cd0ac123254 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -107,6 +107,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -114,9 +116,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "list-global-webhooks", "category": "enterprise-admin", @@ -330,6 +330,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -337,9 +339,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "create-a-global-webhook", "category": "enterprise-admin", @@ -536,6 +536,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -543,9 +545,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "get-a-global-webhook", "category": "enterprise-admin", @@ -750,6 +750,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -757,9 +759,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "update-a-global-webhook", "category": "enterprise-admin", @@ -947,6 +947,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -954,9 +956,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "delete-a-global-webhook", "category": "enterprise-admin", @@ -1025,6 +1025,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -1032,9 +1034,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "ping-a-global-webhook", "category": "enterprise-admin", @@ -1852,6 +1852,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -1859,9 +1861,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "list-pre-receive-environments", "category": "enterprise-admin", @@ -1948,6 +1948,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -1955,9 +1957,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "create-a-pre-receive-environment", "category": "enterprise-admin", @@ -2036,6 +2036,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2043,9 +2045,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "get-a-pre-receive-environment", "category": "enterprise-admin", @@ -2133,6 +2133,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2140,9 +2142,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "update-a-pre-receive-environment", "category": "enterprise-admin", @@ -2227,6 +2227,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2234,9 +2236,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "delete-a-pre-receive-environment", "category": "enterprise-admin", @@ -2300,6 +2300,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2307,9 +2309,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "start-a-pre-receive-environment-download", "category": "enterprise-admin", @@ -2374,6 +2374,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2381,9 +2383,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "get-the-download-status-for-a-pre-receive-environment", "category": "enterprise-admin", @@ -2484,6 +2484,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2491,9 +2493,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "list-pre-receive-hooks", "category": "enterprise-admin", @@ -2630,6 +2630,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2637,9 +2639,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "create-a-pre-receive-hook", "category": "enterprise-admin", @@ -2759,6 +2759,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2766,9 +2768,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "get-a-pre-receive-hook", "category": "enterprise-admin", @@ -2904,6 +2904,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2911,9 +2913,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "update-a-pre-receive-hook", "category": "enterprise-admin", @@ -3033,6 +3033,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -3040,9 +3042,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "delete-a-pre-receive-hook", "category": "enterprise-admin", @@ -15706,6 +15706,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, @@ -15713,9 +15715,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "apps", - "subcategory": "installations" + ] }, "slug": "list-repositories-accessible-to-the-app-installation", "category": "apps", @@ -23929,6 +23929,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -23936,9 +23938,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "list-pre-receive-hooks-for-an-organization", "category": "enterprise-admin", @@ -24007,6 +24007,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -24014,9 +24016,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "get-a-pre-receive-hook-for-an-organization", "category": "enterprise-admin", @@ -24118,6 +24118,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -24125,9 +24127,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "update-pre-receive-hook-enforcement-for-an-organization", "category": "enterprise-admin", @@ -24216,6 +24216,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -24223,9 +24225,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "remove-pre-receive-hook-enforcement-for-an-organization", "category": "enterprise-admin", @@ -64460,6 +64460,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -64467,9 +64469,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "list-pre-receive-hooks-for-a-repository", "category": "enterprise-admin", @@ -64547,6 +64547,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -64554,9 +64556,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "get-a-pre-receive-hook-for-a-repository", "category": "enterprise-admin", @@ -64662,6 +64662,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -64669,9 +64671,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "update-pre-receive-hook-enforcement-for-a-repository", "category": "enterprise-admin", @@ -64765,6 +64765,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -64772,9 +64774,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "remove-pre-receive-hook-enforcement-for-a-repository", "category": "enterprise-admin", @@ -65584,16 +65584,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.1/rest/reference/reactions) reactions.", "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + }, + { + "required": false, + "name": "comfort-fade", + "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@3.1/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.", + "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "list-review-comments-in-a-repository", "category": "pulls", @@ -65671,16 +65677,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.1/rest/reference/reactions) reactions.", "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + }, + { + "required": false, + "name": "comfort-fade", + "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@3.1/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.", + "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "get-a-review-comment-for-a-pull-request", "category": "pulls", @@ -65790,6 +65802,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, @@ -65797,9 +65811,7 @@ "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@3.1/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.", "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "update-a-review-comment-for-a-pull-request", "category": "pulls", @@ -66699,16 +66711,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.1/rest/reference/reactions) reactions.", "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + }, + { + "required": false, + "name": "comfort-fade", + "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@3.1/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.", + "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "list-review-comments-on-a-pull-request", "category": "pulls", @@ -66915,6 +66933,8 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, @@ -66922,9 +66942,7 @@ "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@3.1/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.", "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "create-a-review-comment-for-a-pull-request", "category": "pulls", @@ -72865,6 +72883,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, @@ -72872,9 +72891,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "repos", - "subcategory": null + ] }, "slug": "get-all-repository-topics", "category": "repos", @@ -72985,6 +73002,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, @@ -72992,9 +73010,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "repos", - "subcategory": null + ] }, "slug": "replace-all-repository-topics", "category": "repos", @@ -74141,6 +74157,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": false, @@ -74148,9 +74165,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "search", - "subcategory": null + ] }, "slug": "search-repositories", "category": "search", @@ -74243,6 +74258,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": true, @@ -74250,9 +74266,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "search", - "subcategory": null + ] }, "slug": "search-topics", "category": "search", @@ -80259,6 +80273,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, @@ -80266,9 +80282,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "apps", - "subcategory": "installations" + ] }, "slug": "list-repositories-accessible-to-the-user-access-token", "category": "apps", diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index fbf48b00b648..7bbbc8d2cd7b 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -107,6 +107,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -114,9 +116,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "list-global-webhooks", "category": "enterprise-admin", @@ -330,6 +330,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -337,9 +339,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "create-a-global-webhook", "category": "enterprise-admin", @@ -536,6 +536,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -543,9 +545,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "get-a-global-webhook", "category": "enterprise-admin", @@ -750,6 +750,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -757,9 +759,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "update-a-global-webhook", "category": "enterprise-admin", @@ -947,6 +947,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -954,9 +956,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "delete-a-global-webhook", "category": "enterprise-admin", @@ -1025,6 +1025,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "global-webhooks", "previews": [ { "required": true, @@ -1032,9 +1034,7 @@ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```", "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" } - ], - "category": "enterprise-admin", - "subcategory": "global-webhooks" + ] }, "slug": "ping-a-global-webhook", "category": "enterprise-admin", @@ -1852,6 +1852,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -1859,9 +1861,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "list-pre-receive-environments", "category": "enterprise-admin", @@ -1948,6 +1948,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -1955,9 +1957,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "create-a-pre-receive-environment", "category": "enterprise-admin", @@ -2036,6 +2036,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2043,9 +2045,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "get-a-pre-receive-environment", "category": "enterprise-admin", @@ -2133,6 +2133,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2140,9 +2142,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "update-a-pre-receive-environment", "category": "enterprise-admin", @@ -2227,6 +2227,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2234,9 +2236,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "delete-a-pre-receive-environment", "category": "enterprise-admin", @@ -2300,6 +2300,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2307,9 +2309,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "start-a-pre-receive-environment-download", "category": "enterprise-admin", @@ -2374,6 +2374,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-environments", "previews": [ { "required": true, @@ -2381,9 +2383,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-environments" + ] }, "slug": "get-the-download-status-for-a-pre-receive-environment", "category": "enterprise-admin", @@ -2484,6 +2484,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2491,9 +2493,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "list-pre-receive-hooks", "category": "enterprise-admin", @@ -2630,6 +2630,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2637,9 +2639,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "create-a-pre-receive-hook", "category": "enterprise-admin", @@ -2759,6 +2759,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2766,9 +2768,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "get-a-pre-receive-hook", "category": "enterprise-admin", @@ -2904,6 +2904,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -2911,9 +2913,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "update-a-pre-receive-hook", "category": "enterprise-admin", @@ -3033,6 +3033,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "pre-receive-hooks", "previews": [ { "required": true, @@ -3040,9 +3042,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "pre-receive-hooks" + ] }, "slug": "delete-a-pre-receive-hook", "category": "enterprise-admin", @@ -15926,6 +15926,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, @@ -15933,9 +15935,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "apps", - "subcategory": "installations" + ] }, "slug": "list-repositories-accessible-to-the-app-installation", "category": "apps", @@ -24423,6 +24423,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -24430,9 +24432,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "list-pre-receive-hooks-for-an-organization", "category": "enterprise-admin", @@ -24501,6 +24501,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -24508,9 +24510,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "get-a-pre-receive-hook-for-an-organization", "category": "enterprise-admin", @@ -24612,6 +24612,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -24619,9 +24621,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "update-pre-receive-hook-enforcement-for-an-organization", "category": "enterprise-admin", @@ -24710,6 +24710,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "org-pre-receive-hooks", "previews": [ { "required": true, @@ -24717,9 +24719,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "org-pre-receive-hooks" + ] }, "slug": "remove-pre-receive-hook-enforcement-for-an-organization", "category": "enterprise-admin", @@ -66635,6 +66635,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -66642,9 +66644,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "list-pre-receive-hooks-for-a-repository", "category": "enterprise-admin", @@ -66722,6 +66722,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -66729,9 +66731,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "get-a-pre-receive-hook-for-a-repository", "category": "enterprise-admin", @@ -66837,6 +66837,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -66844,9 +66846,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "update-pre-receive-hook-enforcement-for-a-repository", "category": "enterprise-admin", @@ -66940,6 +66940,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks", "previews": [ { "required": true, @@ -66947,9 +66949,7 @@ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" } - ], - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + ] }, "slug": "remove-pre-receive-hook-enforcement-for-a-repository", "category": "enterprise-admin", @@ -67759,16 +67759,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.2/rest/reference/reactions) reactions.", "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + }, + { + "required": false, + "name": "comfort-fade", + "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@3.2/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.", + "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "list-review-comments-in-a-repository", "category": "pulls", @@ -67846,16 +67852,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.2/rest/reference/reactions) reactions.", "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + }, + { + "required": false, + "name": "comfort-fade", + "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@3.2/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.", + "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "get-a-review-comment-for-a-pull-request", "category": "pulls", @@ -67965,6 +67977,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, @@ -67972,9 +67986,7 @@ "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@3.2/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.", "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "update-a-review-comment-for-a-pull-request", "category": "pulls", @@ -68874,16 +68886,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\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@3.2/rest/reference/reactions) reactions.", "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + }, + { + "required": false, + "name": "comfort-fade", + "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@3.2/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.", + "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "list-review-comments-on-a-pull-request", "category": "pulls", @@ -69090,6 +69108,8 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments", "previews": [ { "required": false, @@ -69097,9 +69117,7 @@ "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@3.2/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.", "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" } - ], - "category": "pulls", - "subcategory": "comments" + ] }, "slug": "create-a-review-comment-for-a-pull-request", "category": "pulls", @@ -75189,6 +75207,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, @@ -75196,9 +75215,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "repos", - "subcategory": null + ] }, "slug": "get-all-repository-topics", "category": "repos", @@ -75309,6 +75326,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", "previews": [ { "required": true, @@ -75316,9 +75334,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "repos", - "subcategory": null + ] }, "slug": "replace-all-repository-topics", "category": "repos", @@ -76928,6 +76944,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": false, @@ -76935,9 +76952,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "search", - "subcategory": null + ] }, "slug": "search-repositories", "category": "search", @@ -77030,6 +77045,7 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "search", "previews": [ { "required": true, @@ -77037,9 +77053,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "search", - "subcategory": null + ] }, "slug": "search-topics", "category": "search", @@ -83046,6 +83060,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations", "previews": [ { "required": false, @@ -83053,9 +83069,7 @@ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" } - ], - "category": "apps", - "subcategory": "installations" + ] }, "slug": "list-repositories-accessible-to-the-user-access-token", "category": "apps", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 8a762ecc331e..06c0682a43e0 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -85,13 +85,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://{hostname}/api/v3/admin/hooks", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://{hostname}/api/v3/admin/hooks
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/hooks", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/hooks
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /admin/hooks', {\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})", - "html": "
await octokit.request('GET /admin/hooks', {\n  mediaType: {\n    previews: [\n      'superpro'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /admin/hooks')", + "html": "
await octokit.request('GET /admin/hooks')\n
" } ], "summary": "List global webhooks", @@ -107,14 +107,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```", - "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" }, @@ -139,29 +131,17 @@ "verb": "post", "requestPath": "/admin/hooks", "serverUrl": "https://{hostname}/api/v3", - "parameters": [ - { - "name": "accept", - "description": "This API is under preview and subject to change.", - "in": "header", - "schema": { - "type": "string", - "default": "application/vnd.github.superpro-preview+json" - }, - "required": true, - "descriptionHTML": "

This API is under preview and subject to change.

" - } - ], + "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://{hostname}/api/v3/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://{hostname}/api/v3/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /admin/hooks', {\n name: 'name',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n },\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})", - "html": "
await octokit.request('POST /admin/hooks', {\n  name: 'name',\n  config: {\n    url: 'url',\n    content_type: 'content_type',\n    secret: 'secret',\n    insecure_ssl: 'insecure_ssl'\n  },\n  mediaType: {\n    previews: [\n      'superpro'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /admin/hooks', {\n name: 'name',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n }\n})", + "html": "
await octokit.request('POST /admin/hooks', {\n  name: 'name',\n  config: {\n    url: 'url',\n    content_type: 'content_type',\n    secret: 'secret',\n    insecure_ssl: 'insecure_ssl'\n  }\n})\n
" } ], "summary": "Create a global webhook", @@ -330,14 +310,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```", - "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" }, @@ -490,17 +462,6 @@ "requestPath": "/admin/hooks/{hook_id}", "serverUrl": "https://{hostname}/api/v3", "parameters": [ - { - "name": "accept", - "description": "This API is under preview and subject to change.", - "in": "header", - "schema": { - "type": "string", - "default": "application/vnd.github.superpro-preview+json" - }, - "required": true, - "descriptionHTML": "

This API is under preview and subject to change.

" - }, { "name": "hook_id", "in": "path", @@ -514,13 +475,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://{hostname}/api/v3/admin/hooks/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://{hostname}/api/v3/admin/hooks/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/hooks/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/hooks/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /admin/hooks/{hook_id}', {\n hook_id: 42,\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})", - "html": "
await octokit.request('GET /admin/hooks/{hook_id}', {\n  hook_id: 42,\n  mediaType: {\n    previews: [\n      'superpro'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /admin/hooks/{hook_id}', {\n hook_id: 42\n})", + "html": "
await octokit.request('GET /admin/hooks/{hook_id}', {\n  hook_id: 42\n})\n
" } ], "summary": "Get a global webhook", @@ -536,14 +497,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```", - "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" }, @@ -569,17 +522,6 @@ "requestPath": "/admin/hooks/{hook_id}", "serverUrl": "https://{hostname}/api/v3", "parameters": [ - { - "name": "accept", - "description": "This API is under preview and subject to change.", - "in": "header", - "schema": { - "type": "string", - "default": "application/vnd.github.superpro-preview+json" - }, - "required": true, - "descriptionHTML": "

This API is under preview and subject to change.

" - }, { "name": "hook_id", "in": "path", @@ -593,13 +535,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://{hostname}/api/v3/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://{hostname}/api/v3/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /admin/hooks/{hook_id}', {\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n },\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})", - "html": "
await octokit.request('PATCH /admin/hooks/{hook_id}', {\n  hook_id: 42,\n  config: {\n    url: 'url',\n    content_type: 'content_type',\n    secret: 'secret',\n    insecure_ssl: 'insecure_ssl'\n  },\n  mediaType: {\n    previews: [\n      'superpro'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PATCH /admin/hooks/{hook_id}', {\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n }\n})", + "html": "
await octokit.request('PATCH /admin/hooks/{hook_id}', {\n  hook_id: 42,\n  config: {\n    url: 'url',\n    content_type: 'content_type',\n    secret: 'secret',\n    insecure_ssl: 'insecure_ssl'\n  }\n})\n
" } ], "summary": "Update a global webhook", @@ -750,14 +692,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```", - "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" }, @@ -925,13 +859,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://{hostname}/api/v3/admin/hooks/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://{hostname}/api/v3/admin/hooks/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/hooks/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/hooks/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /admin/hooks/{hook_id}', {\n hook_id: 42,\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /admin/hooks/{hook_id}', {\n  hook_id: 42,\n  mediaType: {\n    previews: [\n      'superpro'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /admin/hooks/{hook_id}', {\n hook_id: 42\n})", + "html": "
await octokit.request('DELETE /admin/hooks/{hook_id}', {\n  hook_id: 42\n})\n
" } ], "summary": "Delete a global webhook", @@ -947,14 +881,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```", - "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" }, @@ -1003,13 +929,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://{hostname}/api/v3/admin/hooks/42/pings", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n  https://{hostname}/api/v3/admin/hooks/42/pings
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/hooks/42/pings", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/hooks/42/pings
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /admin/hooks/{hook_id}/pings', {\n hook_id: 42,\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})", - "html": "
await octokit.request('POST /admin/hooks/{hook_id}/pings', {\n  hook_id: 42,\n  mediaType: {\n    previews: [\n      'superpro'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /admin/hooks/{hook_id}/pings', {\n hook_id: 42\n})", + "html": "
await octokit.request('POST /admin/hooks/{hook_id}/pings', {\n  hook_id: 42\n})\n
" } ], "summary": "Ping a global webhook", @@ -1025,14 +951,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "superpro", - "note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API 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.superpro-preview+json\n```", - "html": "

The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.superpro-preview+json
" - } - ], "category": "enterprise-admin", "subcategory": "global-webhooks" }, @@ -1506,13 +1424,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /admin/pre-receive-environments', {\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})", - "html": "
await octokit.request('GET /admin/pre-receive-environments', {\n  mediaType: {\n    previews: [\n      'eye-scream'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /admin/pre-receive-environments')", + "html": "
await octokit.request('GET /admin/pre-receive-environments')\n
" } ], "summary": "List pre-receive environments", @@ -1528,14 +1446,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", - "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" }, @@ -1564,13 +1474,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments \\\n  -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /admin/pre-receive-environments', {\n name: 'name',\n image_url: 'image_url',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})", - "html": "
await octokit.request('POST /admin/pre-receive-environments', {\n  name: 'name',\n  image_url: 'image_url',\n  mediaType: {\n    previews: [\n      'eye-scream'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /admin/pre-receive-environments', {\n name: 'name',\n image_url: 'image_url'\n})", + "html": "
await octokit.request('POST /admin/pre-receive-environments', {\n  name: 'name',\n  image_url: 'image_url'\n})\n
" } ], "summary": "Create a pre-receive environment", @@ -1624,14 +1534,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", - "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" }, @@ -1690,13 +1592,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})", - "html": "
await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}', {\n  pre_receive_environment_id: 42,\n  mediaType: {\n    previews: [\n      'eye-scream'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42\n})", + "html": "
await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}', {\n  pre_receive_environment_id: 42\n})\n
" } ], "summary": "Get a pre-receive environment", @@ -1712,14 +1614,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", - "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" }, @@ -1758,13 +1652,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42 \\\n  -d '{\"name\":\"name\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})", - "html": "
await octokit.request('PATCH /admin/pre-receive-environments/{pre_receive_environment_id}', {\n  pre_receive_environment_id: 42,\n  name: 'name',\n  mediaType: {\n    previews: [\n      'eye-scream'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PATCH /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n name: 'name'\n})", + "html": "
await octokit.request('PATCH /admin/pre-receive-environments/{pre_receive_environment_id}', {\n  pre_receive_environment_id: 42,\n  name: 'name'\n})\n
" } ], "summary": "Update a pre-receive environment", @@ -1809,14 +1703,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", - "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" }, @@ -1881,13 +1767,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /admin/pre-receive-environments/{pre_receive_environment_id}', {\n  pre_receive_environment_id: 42,\n  mediaType: {\n    previews: [\n      'eye-scream'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42\n})", + "html": "
await octokit.request('DELETE /admin/pre-receive-environments/{pre_receive_environment_id}', {\n  pre_receive_environment_id: 42\n})\n
" } ], "summary": "Delete a pre-receive environment", @@ -1903,14 +1789,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", - "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" }, @@ -1954,13 +1832,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42/downloads", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42/downloads
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42/downloads", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42/downloads
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})", - "html": "
await octokit.request('POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads', {\n  pre_receive_environment_id: 42,\n  mediaType: {\n    previews: [\n      'eye-scream'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads', {\n pre_receive_environment_id: 42\n})", + "html": "
await octokit.request('POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads', {\n  pre_receive_environment_id: 42\n})\n
" } ], "summary": "Start a pre-receive environment download", @@ -1976,14 +1854,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", - "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" }, @@ -2028,13 +1898,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/admin/pre-receive-environments/42/downloads/latest
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})", - "html": "
await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest', {\n  pre_receive_environment_id: 42,\n  mediaType: {\n    previews: [\n      'eye-scream'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest', {\n pre_receive_environment_id: 42\n})", + "html": "
await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest', {\n  pre_receive_environment_id: 42\n})\n
" } ], "summary": "Get the download status for a pre-receive environment", @@ -2050,14 +1920,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "eye-scream", - "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```", - "html": "

APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.eye-scream-preview
" - } - ], "category": "enterprise-admin", "subcategory": "pre-receive-environments" }, @@ -10886,14 +10748,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "apps", "subcategory": "installations" }, @@ -56859,13 +56713,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n  -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n }\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/pages', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  source: {\n    branch: 'branch',\n    path: 'path'\n  }\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/pages', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  source: {\n    branch: 'branch',\n    path: 'path'\n  },\n  mediaType: {\n    previews: [\n      'switcheroo'\n    ]\n  }\n})\n
" } ], "summary": "Create a GitHub AE Pages site", @@ -56973,7 +56827,15 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "pages" + "subcategory": "pages", + "previews": [ + { + "required": true, + "name": "switcheroo", + "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints 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.switcheroo-preview+json\n```", + "html": "

Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.switcheroo-preview+json
" + } + ] }, "slug": "create-a-github-ae-pages-site", "category": "repos", @@ -57356,13 +57218,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/pages
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/pages
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  mediaType: {\n    previews: [\n      'machine-man'\n    ]\n  }\n})\n
" } ], "summary": "Delete a GitHub AE Pages site", @@ -57379,7 +57241,15 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "pages" + "subcategory": "pages", + "previews": [ + { + "required": true, + "name": "machine-man", + "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```", + "html": "

To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json

" + } + ] }, "slug": "delete-a-github-ae-pages-site", "category": "repos", @@ -58489,14 +58359,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -58576,14 +58438,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -58695,14 +58549,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -59583,14 +59429,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -59657,7 +59495,7 @@ } ], "summary": "Create a review comment for a pull request", - "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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "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.\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://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -59702,16 +59540,16 @@ }, "position": { "type": "integer", - "description": "

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

", "enum": [ "LEFT", "RIGHT", @@ -59751,7 +59589,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, "in_reply_to": { @@ -59799,14 +59637,6 @@ "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "comfort-fade", - "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.", - "html": "

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 for more information.

\n

To 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:

\n
application/vnd.github.comfort-fade-preview+json
\n

To show multi-line comment-supported fields in the response, use the comfort-fade preview header and the line parameter.

\n

If you use the comfort-fade preview header, your response will show:

\n\n

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:

\n" - } - ], "category": "pulls", "subcategory": "comments" }, @@ -59817,7 +59647,7 @@ "subcategoryLabel": "Comments", "contentType": "application/json", "notes": [], - "descriptionHTML": "

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.

\n

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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

", + "descriptionHTML": "

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.

\n

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.

\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

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

", "bodyParameters": [ { "type": "string", @@ -59848,16 +59678,16 @@ }, { "type": "integer", - "description": "

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

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

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

", + "description": "

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

", "enum": [ "LEFT", "RIGHT", @@ -59897,7 +59727,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "rawDescription": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "rawDescription": "**Required when using multi-line comments**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "childParamsGroups": [] }, { @@ -65862,13 +65692,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/topics", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/topics
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/topics", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/topics
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/topics', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  mediaType: {\n    previews: [\n      'mercy'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/topics', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], "summary": "Get all repository topics", @@ -65884,14 +65714,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "repos", "subcategory": null }, @@ -65912,11 +65734,6 @@ "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" } ] }, @@ -65947,13 +65764,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/topics \\\n  -d '{\"names\":[\"names\"]}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n names: [\n 'names'\n ],\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  names: [\n    'names'\n  ],\n  mediaType: {\n    previews: [\n      'mercy'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n names: [\n 'names'\n ]\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  names: [\n    'names'\n  ]\n})\n
" } ], "summary": "Replace all repository topics", @@ -66004,14 +65821,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "repos", "subcategory": null }, @@ -66047,11 +65856,6 @@ "httpStatusMessage": "Not Found", "description": "Resource not found" }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", @@ -68098,7 +67902,7 @@ } ], "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "tags": [ "search" ], @@ -68110,14 +67914,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "search", "subcategory": null }, @@ -68126,7 +67922,7 @@ "categoryLabel": "Search", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Find repositories via various criteria. This method returns up to 100 results per page.

\n

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\n

q=tetris+language:assembly&sort=stars&order=desc

\n

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

\n

When you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:

\n

q=topic:ruby+topic:rails

", + "descriptionHTML": "

Find repositories via various criteria. This method returns up to 100 results per page.

\n

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\n

q=tetris+language:assembly&sort=stars&order=desc

\n

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

", "responses": [ { "httpStatusCode": "200", @@ -68190,13 +67986,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://{hostname}/api/v3/search/topics", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n  https://{hostname}/api/v3/search/topics
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/search/topics", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/search/topics
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /search/topics', {\n q: 'q',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})", - "html": "
await octokit.request('GET /search/topics', {\n  q: 'q',\n  mediaType: {\n    previews: [\n      'mercy'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /search/topics', {\n q: 'q'\n})", + "html": "
await octokit.request('GET /search/topics', {\n  q: 'q'\n})\n
" } ], "summary": "Search topics", @@ -68212,14 +68008,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "search", "subcategory": null }, @@ -68240,11 +68028,6 @@ "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" } ] }, @@ -72941,14 +72724,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, 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.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], "category": "apps", "subcategory": "installations" },