github
/
docs
зеркало из https://github.com/github/docs.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Updating OpenAPI descriptions (#17202)

This commit is contained in:
github-openapi-bot 2021-01-07 08:12:24 -05:00 коммит произвёл GitHub
Родитель d5563a663b
Коммит 04619a24b1
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
14 изменённых файлов: 1294 добавлений и 1136 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

198
lib/rest/static/decorated/api.github.com.json
Просмотреть файл

@ -14476,13 +14476,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks</code></pre>"
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /orgs/{org}/blocks', {\n org: 'org',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/blocks'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('GET /orgs/{org}/blocks', {\n org: 'org'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/blocks'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>\n})\n</code></pre>"
}
],
"summary": "List users blocked by an organization",
@ -14498,14 +14498,7 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
}
],
"previews": [],
"category": "orgs",
"subcategory": "blocking"
},
@ -14558,13 +14551,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('GET /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "Check if a user is blocked by an organization",
@ -14580,14 +14573,7 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
}
],
"previews": [],
"category": "orgs",
"subcategory": "blocking"
},
@ -14639,13 +14625,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PUT /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('PUT /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "Block a user from an organization",
@ -14661,14 +14647,7 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
}
],
"previews": [],
"category": "orgs",
"subcategory": "blocking"
},
@ -14720,13 +14699,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/blocks/USERNAME</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('DELETE /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('DELETE /orgs/{org}/blocks/{username}', {\n org: 'org',\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /orgs/{org}/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "Unblock a user from an organization",
@ -14742,14 +14721,7 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
}
],
"previews": [],
"category": "orgs",
"subcategory": "blocking"
},
@ -19509,8 +19481,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -19773,8 +19745,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -27256,8 +27228,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -41030,7 +41002,7 @@
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Response if git hub advanced security is not enabled for this repository"
"description": "Response if github advanced security is not enabled for this repository"
},
{
"httpStatusCode": "404",
@ -41122,7 +41094,7 @@
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Response if git hub advanced security is not enabled for this repository"
"description": "Response if github advanced security is not enabled for this repository"
},
{
"httpStatusCode": "404",
@ -41310,7 +41282,7 @@
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Response if the repository is archived or if git hub advanced security is not enabled for this repository"
"description": "Response if the repository is archived or if github advanced security is not enabled for this repository"
},
{
"httpStatusCode": "503",
@ -41409,7 +41381,7 @@
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Response if git hub advanced security is not enabled for this repository"
"description": "Response if github advanced security is not enabled for this repository"
}
]
},
@ -41566,7 +41538,7 @@
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Response if the repository is archived or if git hub advanced security is not enabled for this repository"
"description": "Response if the repository is archived or if github advanced security is not enabled for this repository"
},
{
"httpStatusCode": "404",
@ -46165,7 +46137,7 @@
}
],
"summary": "Delete a deployment",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"",
"tags": [
"repos"
],
@ -46205,7 +46177,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>To ensure there can always be an active deployment, you can only delete an <em>inactive</em> deployment. Anyone with <code>repo</code> or <code>repo_deployment</code> scopes can delete an inactive deployment.</p>\n<p>To set a deployment as inactive, you must:</p>\n<ul>\n<li>Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.</li>\n<li>Mark the active deployment as inactive by adding any non-successful deployment status.</li>\n</ul>\n<p>For more information, see \"<a href=\"https://docs.github.com/rest/reference/repos/deployments/#create-a-deployment\">Create a deployment</a>\" and \"<a href=\"https://docs.github.com/rest/reference/repos#create-a-deployment-status\">Create a deployment status</a>.\"</p>"
"descriptionHTML": "<p>To ensure there can always be an active deployment, you can only delete an <em>inactive</em> deployment. Anyone with <code>repo</code> or <code>repo_deployment</code> scopes can delete an inactive deployment.</p>\n<p>To set a deployment as inactive, you must:</p>\n<ul>\n<li>Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.</li>\n<li>Mark the active deployment as inactive by adding any non-successful deployment status.</li>\n</ul>\n<p>For more information, see \"<a href=\"https://docs.github.com/rest/reference/repos/#create-a-deployment\">Create a deployment</a>\" and \"<a href=\"https://docs.github.com/rest/reference/repos#create-a-deployment-status\">Create a deployment status</a>.\"</p>"
},
{
"verb": "get",
@ -57657,7 +57629,7 @@
}
],
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -57678,7 +57650,7 @@
"categoryLabel": "Licenses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/rest/reference/repos/contents#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/rest/reference/repos#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -62529,7 +62501,7 @@
}
],
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -62602,7 +62574,7 @@
"category": "pulls",
"categoryLabel": "Pulls",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "string",
@ -62827,7 +62799,7 @@
}
],
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -62895,7 +62867,7 @@
"subcategory": "review-requests",
"subcategoryLabel": "Review requests",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "array of strings",
@ -63239,7 +63211,7 @@
}
],
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -63469,7 +63441,7 @@
"subcategory": "reviews",
"subcategoryLabel": "Reviews",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/rest/reference/media/#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -75377,7 +75349,7 @@
}
],
"summary": "Create reaction for a team discussion comment (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://docs.github.comt/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"tags": [
"reactions"
],
@ -75443,7 +75415,7 @@
"category": "reactions",
"categoryLabel": "Reactions",
"notes": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.comt/rest/reference/reactions#create-reaction-for-a-team-discussion-comment\"><code>Create reaction for a team discussion comment</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this team discussion comment.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this team discussion comment.</p>",
"bodyParameters": [
{
"type": "string",
@ -77097,7 +77069,7 @@
}
],
"summary": "Add or update team repository permissions (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team repository permissions](https://docs.github.comt/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"tags": [
"teams"
],
@ -77162,7 +77134,7 @@
"description": "Validation failed"
}
],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.comt/rest/reference/teams#add-or-update-team-project-permissions\">Add or update team repository permissions</a> endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"bodyParameters": [
{
"type": "string",
@ -78139,13 +78111,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks</code></pre>"
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /user/blocks', {\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /user/blocks'</span>, {\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('GET /user/blocks')",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /user/blocks'</span>)\n</code></pre>"
}
],
"summary": "List users blocked by the authenticated user",
@ -78161,14 +78133,7 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
}
],
"previews": [],
"category": "users",
"subcategory": "blocking"
},
@ -78232,13 +78197,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /user/blocks/{username}', {\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('GET /user/blocks/{username}', {\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "Check if a user is blocked by the authenticated user",
@ -78254,14 +78219,7 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
}
],
"previews": [],
"category": "users",
"subcategory": "blocking"
},
@ -78319,13 +78277,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PUT /user/blocks/{username}', {\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('PUT /user/blocks/{username}', {\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "Block a user",
@ -78341,14 +78299,7 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
}
],
"previews": [],
"category": "users",
"subcategory": "blocking"
},
@ -78411,13 +78362,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.giant-sentry-fist-preview+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/blocks/USERNAME</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('DELETE /user/blocks/{username}', {\n username: 'username',\n mediaType: {\n previews: [\n 'giant-sentry-fist'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'giant-sentry-fist'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('DELETE /user/blocks/{username}', {\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /user/blocks/{username}'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "Unblock a user",
@ -78433,14 +78384,7 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```",
"html": "<p>The API to block users is currently available for developers to preview. See the <a href=\"https://docs.github.com/rest/overview/api-previews#user-blocking\">preview notice</a> for more information.</p>\n<p>To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.giant-sentry-fist-preview+json</code></pre>"
}
],
"previews": [],
"category": "users",
"subcategory": "blocking"
},
@ -79968,7 +79912,7 @@
}
],
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -80013,7 +79957,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "delete",
@ -80053,7 +79997,7 @@
}
],
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -80098,7 +80042,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "get",
@ -82847,8 +82791,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",

66
lib/rest/static/decorated/ghes-2.18.json
Просмотреть файл

@ -108,8 +108,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -330,8 +330,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -535,8 +535,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -749,8 +749,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -945,8 +945,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -1023,8 +1023,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -6544,7 +6544,7 @@
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Default response",
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"timeline_url\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"current_user_public_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"current_user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_actor_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_url\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_urls\"</span>: [\n <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>\n ],\n <span class=\"hljs-attr\">\"_links\"</span>: [\n {\n <span class=\"hljs-attr\">\"timeline\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_public\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_actor\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organization\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organizations\"</span>: [\n {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n }\n ]\n }\n ]\n}\n</code></pre>"
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"timeline_url\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"current_user_public_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"current_user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_actor_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_url\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_urls\"</span>: [\n <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>\n ],\n <span class=\"hljs-attr\">\"_links\"</span>: {\n <span class=\"hljs-attr\">\"timeline\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_public\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_actor\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organization\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organizations\"</span>: [\n {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n }\n ]\n }\n}\n</code></pre>"
}
]
},
@ -14029,8 +14029,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -14293,8 +14293,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -17634,8 +17634,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -41037,7 +41037,7 @@
}
],
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -41058,7 +41058,7 @@
"categoryLabel": "Licenses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos/contents#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -46075,7 +46075,7 @@
}
],
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -46148,7 +46148,7 @@
"category": "pulls",
"categoryLabel": "Pulls",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "string",
@ -46373,7 +46373,7 @@
}
],
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -46441,7 +46441,7 @@
"subcategory": "review-requests",
"subcategoryLabel": "Review requests",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "array of strings",
@ -46785,7 +46785,7 @@
}
],
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -47015,7 +47015,7 @@
"subcategory": "reviews",
"subcategoryLabel": "Reviews",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/media/#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -58614,7 +58614,7 @@
}
],
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.18/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -58666,7 +58666,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/enterprise-server@2.18/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "delete",
@ -58706,7 +58706,7 @@
}
],
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.18/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -58758,7 +58758,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/enterprise-server@2.18/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "get",
@ -60343,8 +60343,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.18/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",

66
lib/rest/static/decorated/ghes-2.19.json
Просмотреть файл

@ -108,8 +108,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -330,8 +330,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -535,8 +535,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -749,8 +749,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -945,8 +945,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -1023,8 +1023,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -6544,7 +6544,7 @@
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Default response",
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"timeline_url\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"current_user_public_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"current_user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_actor_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_url\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_urls\"</span>: [\n <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>\n ],\n <span class=\"hljs-attr\">\"_links\"</span>: [\n {\n <span class=\"hljs-attr\">\"timeline\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_public\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_actor\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organization\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organizations\"</span>: [\n {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n }\n ]\n }\n ]\n}\n</code></pre>"
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"timeline_url\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"current_user_public_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"current_user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_actor_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_url\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_urls\"</span>: [\n <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>\n ],\n <span class=\"hljs-attr\">\"_links\"</span>: {\n <span class=\"hljs-attr\">\"timeline\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_public\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_actor\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organization\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organizations\"</span>: [\n {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n }\n ]\n }\n}\n</code></pre>"
}
]
},
@ -14125,8 +14125,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -14389,8 +14389,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -17722,8 +17722,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -41846,7 +41846,7 @@
}
],
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.19/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -41867,7 +41867,7 @@
"categoryLabel": "Licenses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos/contents#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -46871,7 +46871,7 @@
}
],
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -46944,7 +46944,7 @@
"category": "pulls",
"categoryLabel": "Pulls",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "string",
@ -47169,7 +47169,7 @@
}
],
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -47237,7 +47237,7 @@
"subcategory": "review-requests",
"subcategoryLabel": "Review requests",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "array of strings",
@ -47581,7 +47581,7 @@
}
],
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.19/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -47811,7 +47811,7 @@
"subcategory": "reviews",
"subcategoryLabel": "Reviews",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/media/#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -59198,7 +59198,7 @@
}
],
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.19/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -59250,7 +59250,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/enterprise-server@2.19/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "delete",
@ -59290,7 +59290,7 @@
}
],
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.19/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -59342,7 +59342,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/enterprise-server@2.19/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "get",
@ -60927,8 +60927,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.19/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",

66
lib/rest/static/decorated/ghes-2.20.json
Просмотреть файл

@ -108,8 +108,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -330,8 +330,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -535,8 +535,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -749,8 +749,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -945,8 +945,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -1023,8 +1023,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -6961,7 +6961,7 @@
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Default response",
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"timeline_url\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"current_user_public_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"current_user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_actor_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_url\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_urls\"</span>: [\n <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>\n ],\n <span class=\"hljs-attr\">\"_links\"</span>: [\n {\n <span class=\"hljs-attr\">\"timeline\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_public\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_actor\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organization\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organizations\"</span>: [\n {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n }\n ]\n }\n ]\n}\n</code></pre>"
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"timeline_url\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"current_user_public_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"current_user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_actor_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_url\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_urls\"</span>: [\n <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>\n ],\n <span class=\"hljs-attr\">\"_links\"</span>: {\n <span class=\"hljs-attr\">\"timeline\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_public\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_actor\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organization\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organizations\"</span>: [\n {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n }\n ]\n }\n}\n</code></pre>"
}
]
},
@ -14592,8 +14592,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -14856,8 +14856,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -18189,8 +18189,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -42313,7 +42313,7 @@
}
],
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.20/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -42334,7 +42334,7 @@
"categoryLabel": "Licenses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos/contents#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -47521,7 +47521,7 @@
}
],
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -47594,7 +47594,7 @@
"category": "pulls",
"categoryLabel": "Pulls",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "string",
@ -47819,7 +47819,7 @@
}
],
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -47887,7 +47887,7 @@
"subcategory": "review-requests",
"subcategoryLabel": "Review requests",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "array of strings",
@ -48231,7 +48231,7 @@
}
],
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.20/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -48461,7 +48461,7 @@
"subcategory": "reviews",
"subcategoryLabel": "Reviews",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/media/#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -59754,7 +59754,7 @@
}
],
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.20/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.20/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -59806,7 +59806,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/enterprise-server@2.20/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "delete",
@ -59846,7 +59846,7 @@
}
],
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.20/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.20/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -59898,7 +59898,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/enterprise-server@2.20/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "get",
@ -61483,8 +61483,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",

78
lib/rest/static/decorated/ghes-2.21.json
Просмотреть файл

@ -108,8 +108,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -330,8 +330,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -535,8 +535,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -749,8 +749,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -945,8 +945,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -1023,8 +1023,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
"html": "<p>The <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -6955,7 +6955,7 @@
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Default response",
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"timeline_url\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"current_user_public_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"current_user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_actor_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_url\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_urls\"</span>: [\n <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>\n ],\n <span class=\"hljs-attr\">\"_links\"</span>: [\n {\n <span class=\"hljs-attr\">\"timeline\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_public\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_actor\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organization\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organizations\"</span>: [\n {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n }\n ]\n }\n ]\n}\n</code></pre>"
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"timeline_url\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"current_user_public_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"current_user_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_actor_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_url\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"current_user_organization_urls\"</span>: [\n <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>\n ],\n <span class=\"hljs-attr\">\"_links\"</span>: {\n <span class=\"hljs-attr\">\"timeline\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/timeline\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/{user}\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_public\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_actor\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat.private.actor?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organization\"</span>: {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n <span class=\"hljs-attr\">\"current_user_organizations\"</span>: [\n {\n <span class=\"hljs-attr\">\"href\"</span>: <span class=\"hljs-string\">\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"application/atom+xml\"</span>\n }\n ]\n }\n}\n</code></pre>"
}
]
},
@ -14586,8 +14586,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -14850,8 +14850,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -21656,8 +21656,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -36249,7 +36249,7 @@
}
],
"summary": "Delete a deployment",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@2.21/rest/reference/repos/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-deployment-status).\"",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@2.21/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-deployment-status).\"",
"tags": [
"repos"
],
@ -36289,7 +36289,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>To ensure there can always be an active deployment, you can only delete an <em>inactive</em> deployment. Anyone with <code>repo</code> or <code>repo_deployment</code> scopes can delete an inactive deployment.</p>\n<p>To set a deployment as inactive, you must:</p>\n<ul>\n<li>Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.</li>\n<li>Mark the active deployment as inactive by adding any non-successful deployment status.</li>\n</ul>\n<p>For more information, see \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos/deployments/#create-a-deployment\">Create a deployment</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-deployment-status\">Create a deployment status</a>.\"</p>"
"descriptionHTML": "<p>To ensure there can always be an active deployment, you can only delete an <em>inactive</em> deployment. Anyone with <code>repo</code> or <code>repo_deployment</code> scopes can delete an inactive deployment.</p>\n<p>To set a deployment as inactive, you must:</p>\n<ul>\n<li>Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.</li>\n<li>Mark the active deployment as inactive by adding any non-successful deployment status.</li>\n</ul>\n<p>For more information, see \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos/#create-a-deployment\">Create a deployment</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-deployment-status\">Create a deployment status</a>.\"</p>"
},
{
"verb": "get",
@ -46148,7 +46148,7 @@
}
],
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.21/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -46169,7 +46169,7 @@
"categoryLabel": "Licenses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos/contents#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -51431,7 +51431,7 @@
}
],
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.21/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -51504,7 +51504,7 @@
"category": "pulls",
"categoryLabel": "Pulls",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.21/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "string",
@ -51729,7 +51729,7 @@
}
],
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.21/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -51797,7 +51797,7 @@
"subcategory": "review-requests",
"subcategoryLabel": "Review requests",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@2.21/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "array of strings",
@ -52141,7 +52141,7 @@
}
],
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.21/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -52371,7 +52371,7 @@
"subcategory": "reviews",
"subcategoryLabel": "Reviews",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/media/#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -60244,7 +60244,7 @@
}
],
"summary": "Create reaction for a team discussion comment (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://docs.github.com/enterprise-server@2.21t/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"tags": [
"reactions"
],
@ -60310,7 +60310,7 @@
"category": "reactions",
"categoryLabel": "Reactions",
"notes": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@2.21t/rest/reference/reactions#create-reaction-for-a-team-discussion-comment\"><code>Create reaction for a team discussion comment</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this team discussion comment.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this team discussion comment.</p>",
"bodyParameters": [
{
"type": "string",
@ -61880,7 +61880,7 @@
}
],
"summary": "Add or update team repository permissions (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team repository permissions](https://docs.github.com/enterprise-server@2.21t/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"tags": [
"teams"
],
@ -61945,7 +61945,7 @@
"description": "Validation failed"
}
],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@2.21t/rest/reference/teams#add-or-update-team-project-permissions\">Add or update team repository permissions</a> endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"bodyParameters": [
{
"type": "string",
@ -63838,7 +63838,7 @@
}
],
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.21/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.21/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -63890,7 +63890,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/enterprise-server@2.21/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "delete",
@ -63930,7 +63930,7 @@
}
],
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.21/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.21/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -63982,7 +63982,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/enterprise-server@2.21/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "get",
@ -65567,8 +65567,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",

97
lib/rest/static/decorated/ghes-2.22.json
Просмотреть файл

Различия файлов скрыты, потому что одна или несколько строк слишком длинны

80
lib/rest/static/decorated/github.ae.json
Просмотреть файл

@ -108,8 +108,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -330,8 +330,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -535,8 +535,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -749,8 +749,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -945,8 +945,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -1023,8 +1023,8 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/enterprise/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
"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": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#global-webhooks\">Global Webhooks API</a> is currently available for developers to preview. To access the API during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.superpro-preview+json</code></pre>"
}
],
"category": "enterprise-admin",
@ -4749,7 +4749,7 @@
}
],
"summary": "Disable encryption at rest",
"description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nDisables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"[Get an encryption status](https://docs.github.com/github-ae@latest/v3/enterprise-admin/encryption-at-#get-encryption-status)\" REST API.\n\nTo unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"[Receiving enterprise support](/admin/enterprise-support/receiving-help-from-github-support).\"",
"description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nDisables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"[Get an encryption status](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-an-encryption-status)\" REST API.\n\nTo unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"[Receiving enterprise support](/admin/enterprise-support/receiving-help-from-github-support).\"",
"operationId": "enterprise-admin/disable-encryption",
"tags": [
"enterprise-admin"
@ -4772,7 +4772,7 @@
"subcategoryLabel": "Encryption at rest",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Warning:</strong> The encryption at rest endpoints are currently in beta and are subject to change.</p>\n<p>Disables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"<a href=\"https://docs.github.com/github-ae@latest/v3/enterprise-admin/encryption-at-#get-encryption-status\">Get an encryption status</a>\" REST API.</p>\n<p>To unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"<a href=\"/admin/enterprise-support/receiving-help-from-github-support\">Receiving enterprise support</a>.\"</p>",
"descriptionHTML": "<p><strong>Warning:</strong> The encryption at rest endpoints are currently in beta and are subject to change.</p>\n<p>Disables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-an-encryption-status\">Get an encryption status</a>\" REST API.</p>\n<p>To unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"<a href=\"/admin/enterprise-support/receiving-help-from-github-support\">Receiving enterprise support</a>.\"</p>",
"responses": [
{
"httpStatusCode": "202",
@ -12545,8 +12545,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -12809,8 +12809,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -19615,8 +19615,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",
@ -34125,7 +34125,7 @@
}
],
"summary": "Delete a deployment",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/github-ae@latest/rest/reference/repos/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-deployment-status).\"",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/github-ae@latest/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-deployment-status).\"",
"tags": [
"repos"
],
@ -34165,7 +34165,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>To ensure there can always be an active deployment, you can only delete an <em>inactive</em> deployment. Anyone with <code>repo</code> or <code>repo_deployment</code> scopes can delete an inactive deployment.</p>\n<p>To set a deployment as inactive, you must:</p>\n<ul>\n<li>Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.</li>\n<li>Mark the active deployment as inactive by adding any non-successful deployment status.</li>\n</ul>\n<p>For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos/deployments/#create-a-deployment\">Create a deployment</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-deployment-status\">Create a deployment status</a>.\"</p>"
"descriptionHTML": "<p>To ensure there can always be an active deployment, you can only delete an <em>inactive</em> deployment. Anyone with <code>repo</code> or <code>repo_deployment</code> scopes can delete an inactive deployment.</p>\n<p>To set a deployment as inactive, you must:</p>\n<ul>\n<li>Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.</li>\n<li>Mark the active deployment as inactive by adding any non-successful deployment status.</li>\n</ul>\n<p>For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos/#create-a-deployment\">Create a deployment</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-deployment-status\">Create a deployment status</a>.\"</p>"
},
{
"verb": "get",
@ -44230,7 +44230,7 @@
}
],
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/github-ae@latest/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/github-ae@latest/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/github-ae@latest/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/github-ae@latest/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -44251,7 +44251,7 @@
"categoryLabel": "Licenses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos/contents#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>Similar to <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#get-repository-content\">Get repository content</a>, this method also supports <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">custom media types</a> for retrieving the raw license content or rendered license HTML.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -49102,7 +49102,7 @@
}
],
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -49175,7 +49175,7 @@
"category": "pulls",
"categoryLabel": "Pulls",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "string",
@ -49400,7 +49400,7 @@
}
],
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -49468,7 +49468,7 @@
"subcategory": "review-requests",
"subcategoryLabel": "Review requests",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/guides#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>",
"bodyParameters": [
{
"type": "array of strings",
@ -49812,7 +49812,7 @@
}
],
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -50042,7 +50042,7 @@
"subcategory": "reviews",
"subcategoryLabel": "Reviews",
"notes": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/github-ae@latest/rest/reference/media/#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://help.github.com/articles/about-notifications/\">notifications</a>. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits\">Abuse rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Dealing with abuse rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state do not include the <code>submitted_at</code> property in the response.</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> 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.</p>",
"responses": [
{
"httpStatusCode": "200",
@ -57111,7 +57111,7 @@
}
],
"summary": "Create reaction for a team discussion comment (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://docs.github.com/github-ae@latestt/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"tags": [
"reactions"
],
@ -57177,7 +57177,7 @@
"category": "reactions",
"categoryLabel": "Reactions",
"notes": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/github-ae@latestt/rest/reference/reactions#create-reaction-for-a-team-discussion-comment\"><code>Create reaction for a team discussion comment</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this team discussion comment.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this team discussion comment.</p>",
"bodyParameters": [
{
"type": "string",
@ -58747,7 +58747,7 @@
}
],
"summary": "Add or update team repository permissions (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team repository permissions](https://docs.github.com/github-ae@latestt/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"tags": [
"teams"
],
@ -58812,7 +58812,7 @@
"description": "Validation failed"
}
],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/github-ae@latestt/rest/reference/teams#add-or-update-team-project-permissions\">Add or update team repository permissions</a> endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"bodyParameters": [
{
"type": "string",
@ -60337,7 +60337,7 @@
}
],
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/github-ae@latest/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -60382,7 +60382,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Add a single repository to an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "delete",
@ -60422,7 +60422,7 @@
}
],
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/github-ae@latest/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -60467,7 +60467,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">command line</a> or the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/oauth-authorizations#create-a-new-authorization\">OAuth Authorizations API</a> or <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> to access this endpoint.</p>"
"descriptionHTML": "<p>Remove a single repository from an installation. The authenticated user must have admin access to the repository.</p>\n<p>You must use a personal access token (which you can create via the <a href=\"https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token\">command line</a> or <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>) to access this endpoint.</p>"
},
{
"verb": "get",
@ -61961,8 +61961,8 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
"html": "<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json</code></pre>"
}
],
"category": "repos",

84
lib/rest/static/dereferenced/api.github.com.deref.json
Просмотреть файл

@ -52544,11 +52544,7 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```"
}
],
"category": "orgs",
"subcategory": "blocking"
@ -52614,11 +52610,7 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```"
}
],
"category": "orgs",
"subcategory": "blocking"
@ -52731,11 +52723,7 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```"
}
],
"category": "orgs",
"subcategory": "blocking"
@ -52779,11 +52767,7 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```"
}
],
"category": "orgs",
"subcategory": "blocking"
@ -73153,7 +73137,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -74494,7 +74478,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -101766,7 +101750,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -139964,7 +139948,7 @@
}
},
"403": {
"description": "Response if GitHub Advanced Security is not enabled for this repository"
"description": "Response if github advanced security is not enabled for this repository"
},
"404": {
"description": "Response if the ref does not match an existing ref"
@ -140356,7 +140340,7 @@
}
},
"403": {
"description": "Response if GitHub Advanced Security is not enabled for this repository"
"description": "Response if github advanced security is not enabled for this repository"
},
"404": {
"description": "Resource Not Found",
@ -140812,7 +140796,7 @@
}
},
"403": {
"description": "Response if the repository is archived, or if GitHub Advanced Security is not enabled for this repository"
"description": "Response if the repository is archived, or if github advanced security is not enabled for this repository"
},
"503": {
"description": "Response when code scanning is not available and you should try again at a later time"
@ -140953,7 +140937,7 @@
}
},
"403": {
"description": "Response if GitHub Advanced Security is not enabled for this repository"
"description": "Response if github advanced security is not enabled for this repository"
}
},
"x-github": {
@ -141054,7 +141038,7 @@
"description": "response"
},
"403": {
"description": "Response if the repository is archived, or if GitHub Advanced Security is not enabled for this repository"
"description": "Response if the repository is archived, or if github advanced security is not enabled for this repository"
},
"404": {
"description": "Response if `commit_sha` or `ref` cannot be found"
@ -163897,7 +163881,7 @@
},
"delete": {
"summary": "Delete a deployment",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"",
"tags": [
"repos"
],
@ -212719,7 +212703,7 @@
"/repos/{owner}/{repo}/license": {
"get": {
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -238809,7 +238793,7 @@
},
"put": {
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -239330,7 +239314,7 @@
},
"post": {
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -243784,7 +243768,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -278982,7 +278966,7 @@
},
"post": {
"summary": "Create reaction for a team discussion comment (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://docs.github.comt/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"tags": [
"reactions"
],
@ -285693,7 +285677,7 @@
},
"put": {
"summary": "Add or update team repository permissions (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team repository permissions](https://docs.github.comt/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"tags": [
"teams"
],
@ -288121,11 +288105,7 @@
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```"
}
],
"category": "users",
"subcategory": "blocking"
@ -288226,11 +288206,7 @@
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```"
}
],
"category": "users",
"subcategory": "blocking"
@ -288398,11 +288374,7 @@
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```"
}
],
"category": "users",
"subcategory": "blocking"
@ -288501,11 +288473,7 @@
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [
{
"required": true,
"name": "giant-sentry-fist",
"note": "The API to block users is currently available for developers to preview. See the [preview notice](https://docs.github.com/rest/overview/api-previews#user-blocking) for more information.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.giant-sentry-fist-preview+json\n```"
}
],
"category": "users",
"subcategory": "blocking"
@ -293313,7 +293281,7 @@
"/user/installations/{installation_id}/repositories/{repository_id}": {
"put": {
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -293401,7 +293369,7 @@
},
"delete": {
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -308983,7 +308951,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",

326
lib/rest/static/dereferenced/ghes-2.18.deref.json
Просмотреть файл

@ -497,7 +497,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -687,7 +687,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -819,7 +819,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1000,7 +1000,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1050,7 +1050,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1102,7 +1102,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/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@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -17719,96 +17719,152 @@
}
},
"_links": {
"type": "array",
"type": "object",
"properties": {
"timeline": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"security_advisories": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_public": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_actor": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organization": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organizations": {
"type": "array",
"items": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
}
}
},
"required": [
"timeline",
"user"
],
"items": {
"type": "object",
"properties": {
"timeline": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_public": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_actor": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organization": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organizations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
}
}
]
}
},
"required": [
@ -17829,40 +17885,38 @@
"current_user_organization_urls": [
"https://github.com/organizations/github/octocat.private.atom?token=abc123"
],
"_links": [
{
"timeline": {
"href": "https://github.com/timeline",
"_links": {
"timeline": {
"href": "https://github.com/timeline",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
}
]
}
]
}
]
}
}
}
}
@ -50514,7 +50568,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -51834,7 +51888,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -67213,7 +67267,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -155034,7 +155088,7 @@
"/repos/{owner}/{repo}/license": {
"get": {
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -180763,7 +180817,7 @@
},
"put": {
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -181284,7 +181338,7 @@
},
"post": {
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.18/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -185696,7 +185750,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -230408,7 +230462,7 @@
"/user/installations/{installation_id}/repositories/{repository_id}": {
"put": {
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.18/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -230500,7 +230554,7 @@
},
"delete": {
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.18/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -238648,7 +238702,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",

326
lib/rest/static/dereferenced/ghes-2.19.deref.json
Просмотреть файл

@ -497,7 +497,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -687,7 +687,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -819,7 +819,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1000,7 +1000,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1050,7 +1050,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1102,7 +1102,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/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@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -17749,96 +17749,152 @@
}
},
"_links": {
"type": "array",
"type": "object",
"properties": {
"timeline": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"security_advisories": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_public": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_actor": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organization": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organizations": {
"type": "array",
"items": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
}
}
},
"required": [
"timeline",
"user"
],
"items": {
"type": "object",
"properties": {
"timeline": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_public": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_actor": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organization": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organizations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
}
}
]
}
},
"required": [
@ -17859,40 +17915,38 @@
"current_user_organization_urls": [
"https://github.com/organizations/github/octocat.private.atom?token=abc123"
],
"_links": [
{
"timeline": {
"href": "https://github.com/timeline",
"_links": {
"timeline": {
"href": "https://github.com/timeline",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
}
]
}
]
}
]
}
}
}
}
@ -51153,7 +51207,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -52473,7 +52527,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -67845,7 +67899,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -158421,7 +158475,7 @@
"/repos/{owner}/{repo}/license": {
"get": {
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.19/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -184141,7 +184195,7 @@
},
"put": {
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -184662,7 +184716,7 @@
},
"post": {
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.19/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -189074,7 +189128,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.19/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -233611,7 +233665,7 @@
"/user/installations/{installation_id}/repositories/{repository_id}": {
"put": {
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.19/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -233703,7 +233757,7 @@
},
"delete": {
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.19/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -241856,7 +241910,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",

326
lib/rest/static/dereferenced/ghes-2.20.deref.json
Просмотреть файл

@ -497,7 +497,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -687,7 +687,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -819,7 +819,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1000,7 +1000,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1050,7 +1050,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1102,7 +1102,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/enterprise/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.20/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@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -19681,96 +19681,152 @@
}
},
"_links": {
"type": "array",
"type": "object",
"properties": {
"timeline": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"security_advisories": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_public": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_actor": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organization": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organizations": {
"type": "array",
"items": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
}
}
},
"required": [
"timeline",
"user"
],
"items": {
"type": "object",
"properties": {
"timeline": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_public": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_actor": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organization": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organizations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
}
}
]
}
},
"required": [
@ -19791,40 +19847,38 @@
"current_user_organization_urls": [
"https://github.com/organizations/github/octocat.private.atom?token=abc123"
],
"_links": [
{
"timeline": {
"href": "https://github.com/timeline",
"_links": {
"timeline": {
"href": "https://github.com/timeline",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
}
]
}
]
}
]
}
}
}
}
@ -53219,7 +53273,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -54548,7 +54602,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -70012,7 +70066,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -159742,7 +159796,7 @@
"/repos/{owner}/{repo}/license": {
"get": {
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.20/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -186114,7 +186168,7 @@
},
"put": {
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -186635,7 +186689,7 @@
},
"post": {
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.20/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -191065,7 +191119,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.20/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.20/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -235682,7 +235736,7 @@
"/user/installations/{installation_id}/repositories/{repository_id}": {
"put": {
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.20/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.20/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -235774,7 +235828,7 @@
},
"delete": {
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.20/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.20/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -243954,7 +244008,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",

332
lib/rest/static/dereferenced/ghes-2.21.deref.json
Просмотреть файл

@ -497,7 +497,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -687,7 +687,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -819,7 +819,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1000,7 +1000,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1050,7 +1050,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1102,7 +1102,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/enterprise/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.21/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@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -19695,96 +19695,152 @@
}
},
"_links": {
"type": "array",
"type": "object",
"properties": {
"timeline": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"security_advisories": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_public": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_actor": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organization": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organizations": {
"type": "array",
"items": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
}
}
},
"required": [
"timeline",
"user"
],
"items": {
"type": "object",
"properties": {
"timeline": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_public": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_actor": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organization": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organizations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
}
}
]
}
},
"required": [
@ -19805,40 +19861,38 @@
"current_user_organization_urls": [
"https://github.com/organizations/github/octocat.private.atom?token=abc123"
],
"_links": [
{
"timeline": {
"href": "https://github.com/timeline",
"_links": {
"timeline": {
"href": "https://github.com/timeline",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
}
]
}
]
}
]
}
}
}
}
@ -53318,7 +53372,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -54657,7 +54711,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -80799,7 +80853,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -124498,7 +124552,7 @@
},
"delete": {
"summary": "Delete a deployment",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@2.21/rest/reference/repos/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-deployment-status).\"",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@2.21/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-deployment-status).\"",
"tags": [
"repos"
],
@ -171054,7 +171108,7 @@
"/repos/{owner}/{repo}/license": {
"get": {
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.21/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -197510,7 +197564,7 @@
},
"put": {
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.21/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -198031,7 +198085,7 @@
},
"post": {
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.21/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -202481,7 +202535,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.21/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.21/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -231918,7 +231972,7 @@
},
"post": {
"summary": "Create reaction for a team discussion comment (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://docs.github.com/enterprise-server@2.21t/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"tags": [
"reactions"
],
@ -238265,7 +238319,7 @@
},
"put": {
"summary": "Add or update team repository permissions (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team repository permissions](https://docs.github.com/enterprise-server@2.21t/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@2.21/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"tags": [
"teams"
],
@ -244509,7 +244563,7 @@
"/user/installations/{installation_id}/repositories/{repository_id}": {
"put": {
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.21/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.21/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -244601,7 +244655,7 @@
},
"delete": {
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.21/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.21/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -252811,7 +252865,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",

345
lib/rest/static/dereferenced/ghes-2.22.deref.json
Просмотреть файл

@ -497,7 +497,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/enterprise/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -687,7 +687,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/enterprise/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -819,7 +819,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/enterprise/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1000,7 +1000,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/enterprise/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1050,7 +1050,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/enterprise/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -1102,7 +1102,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/enterprise/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
"note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.22/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@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
}
],
"category": "enterprise-admin",
@ -23323,96 +23323,152 @@
}
},
"_links": {
"type": "array",
"type": "object",
"properties": {
"timeline": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"security_advisories": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_public": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_actor": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organization": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
},
"current_user_organizations": {
"type": "array",
"items": {
"title": "Link With Type",
"description": "Hypermedia Link with Type",
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"type"
]
}
}
},
"required": [
"timeline",
"user"
],
"items": {
"type": "object",
"properties": {
"timeline": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_public": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_actor": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organization": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"current_user_organizations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
}
}
]
}
},
"required": [
@ -23433,40 +23489,38 @@
"current_user_organization_urls": [
"https://github.com/organizations/github/octocat.private.atom?token=abc123"
],
"_links": [
{
"timeline": {
"href": "https://github.com/timeline",
"_links": {
"timeline": {
"href": "https://github.com/timeline",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/octocat",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/octocat.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/octocat.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
"type": "application/atom+xml"
}
]
}
]
}
]
}
}
}
}
@ -64077,7 +64131,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.22/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -65418,7 +65472,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.22/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -91706,7 +91760,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.22/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -129006,9 +129060,6 @@
}
}
},
"403": {
"description": "Response if GitHub Advanced Security is not enabled for this repository"
},
"404": {
"description": "Response if the ref does not match an existing ref"
},
@ -129398,9 +129449,6 @@
}
}
},
"403": {
"description": "Response if GitHub Advanced Security is not enabled for this repository"
},
"404": {
"description": "Resource Not Found",
"content": {
@ -129855,7 +129903,7 @@
}
},
"403": {
"description": "Response if the repository is archived, or if GitHub Advanced Security is not enabled for this repository"
"description": "Response if the repository is archived"
},
"503": {
"description": "Response when code scanning is not available and you should try again at a later time"
@ -129994,9 +130042,6 @@
}
}
}
},
"403": {
"description": "Response if GitHub Advanced Security is not enabled for this repository"
}
},
"x-github": {
@ -130097,7 +130142,7 @@
"description": "response"
},
"403": {
"description": "Response if the repository is archived, or if GitHub Advanced Security is not enabled for this repository"
"description": "Response if the repository is archived"
},
"404": {
"description": "Response if `commit_sha` or `ref` cannot be found"
@ -152633,7 +152678,7 @@
},
"delete": {
"summary": "Delete a deployment",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@2.22/rest/reference/repos/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-deployment-status).\"",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@2.22/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-deployment-status).\"",
"tags": [
"repos"
],
@ -199150,7 +199195,7 @@
"/repos/{owner}/{repo}/license": {
"get": {
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.22/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -225625,7 +225670,7 @@
},
"put": {
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.22/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -226146,7 +226191,7 @@
},
"post": {
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@2.22/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -230600,7 +230645,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.22/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.22/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -260062,7 +260107,7 @@
},
"post": {
"summary": "Create reaction for a team discussion comment (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://docs.github.com/enterprise-server@2.22t/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"tags": [
"reactions"
],
@ -266514,7 +266559,7 @@
},
"put": {
"summary": "Add or update team repository permissions (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team repository permissions](https://docs.github.com/enterprise-server@2.22t/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@2.22/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"tags": [
"teams"
],
@ -272740,7 +272785,7 @@
"/user/installations/{installation_id}/repositories/{repository_id}": {
"put": {
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.22/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -272828,7 +272873,7 @@
},
"delete": {
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.22/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@2.22/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@2.22/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -281060,7 +281105,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.22/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",

40
lib/rest/static/dereferenced/github.ae.deref.json
Просмотреть файл

@ -497,7 +497,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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```"
"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",
@ -687,7 +687,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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```"
"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",
@ -819,7 +819,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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```"
"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",
@ -1000,7 +1000,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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```"
"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",
@ -1050,7 +1050,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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```"
"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",
@ -1102,7 +1102,7 @@
{
"required": true,
"name": "superpro",
"note": "The [Global Webhooks API](https://docs.github.com/github-ae@latest/enterprise/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```"
"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",
@ -10621,7 +10621,7 @@
},
"delete": {
"summary": "Disable encryption at rest",
"description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nDisables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"[Get an encryption status](https://docs.github.com/github-ae@latest/v3/enterprise-admin/encryption-at-#get-encryption-status)\" REST API.\n\nTo unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"[Receiving enterprise support](/admin/enterprise-support/receiving-help-from-github-support).\"",
"description": "**Warning:** The encryption at rest endpoints are currently in beta and are subject to change.\n\nDisables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the \"[Get an encryption status](https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-an-encryption-status)\" REST API.\n\nTo unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see \"[Receiving enterprise support](/admin/enterprise-support/receiving-help-from-github-support).\"",
"operationId": "enterprise-admin/disable-encryption",
"tags": [
"enterprise-admin"
@ -47647,7 +47647,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -48988,7 +48988,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -75279,7 +75279,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",
@ -118974,7 +118974,7 @@
},
"delete": {
"summary": "Delete a deployment",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/github-ae@latest/rest/reference/repos/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-deployment-status).\"",
"description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/github-ae@latest/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-deployment-status).\"",
"tags": [
"repos"
],
@ -165738,7 +165738,7 @@
"/repos/{owner}/{repo}/license": {
"get": {
"summary": "Get the license for a repository",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/github-ae@latest/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/github-ae@latest/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/github-ae@latest/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/github-ae@latest/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
"tags": [
"licenses"
],
@ -191828,7 +191828,7 @@
},
"put": {
"summary": "Merge a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -192349,7 +192349,7 @@
},
"post": {
"summary": "Request reviewers for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
"description": "This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
"tags": [
"pulls"
],
@ -196803,7 +196803,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/reference/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `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.",
"tags": [
"pulls"
],
@ -224979,7 +224979,7 @@
},
"post": {
"summary": "Create reaction for a team discussion comment (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://docs.github.com/github-ae@latestt/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
"tags": [
"reactions"
],
@ -231431,7 +231431,7 @@
},
"put": {
"summary": "Add or update team repository permissions (Legacy)",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team repository permissions](https://docs.github.com/github-ae@latestt/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"tags": [
"teams"
],
@ -237039,7 +237039,7 @@
"/user/installations/{installation_id}/repositories/{repository_id}": {
"put": {
"summary": "Add a repository to an app installation",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/github-ae@latest/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -237127,7 +237127,7 @@
},
"delete": {
"summary": "Remove a repository from an app installation",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/github-ae@latest/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
"tags": [
"apps"
],
@ -245183,7 +245183,7 @@
{
"required": false,
"name": "baptiste",
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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.baptiste-preview+json\n```"
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys 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\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
}
],
"category": "repos",