jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-25 02:17:36 -05:00
Code Issues Projects Releases Wiki Activity

Add decorated OpenAPI schema files

Browse Source
This commit is contained in:
github-openapi-bot
2020-12-15 16:11:07 +00:00
parent 8e2b7f972a
commit 8f6fd7ef5d
5 changed files with 90 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
lib/rest/static/decorated/api.github.com.json
View File

File diff suppressed because one or more lines are too long

16
lib/rest/static/decorated/ghes-2.20.json
View File

@@ -4632,7 +4632,7 @@
}
],
"summary": "Revoke a grant for an application",
"description": "**Deprecation Notice:** GitHub Enterprise Server will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server](https://github.com/settings/applications#authorized).",
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server](https://github.com/settings/applications#authorized).",
"tags": [
"apps"
],
@@ -4665,7 +4665,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. You must also provide a valid token as <code>:access_token</code> and the grant for the token's owner will be deleted.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on <a href=\"https://github.com/settings/applications#authorized\">the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server</a>.</p>"
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. You must also provide a valid token as <code>:access_token</code> and the grant for the token's owner will be deleted.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on <a href=\"https://github.com/settings/applications#authorized\">the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server</a>.</p>"
},
{
"verb": "post",
@@ -5005,7 +5005,7 @@
}
],
"summary": "Check an authorization",
"description": "**Deprecation Notice:** GitHub Enterprise Server will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"tags": [
"apps"
],
@@ -5031,7 +5031,7 @@
"subcategoryLabel": "Oauth applications",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -5083,7 +5083,7 @@
}
],
"summary": "Reset an authorization",
"description": "**Deprecation Notice:** GitHub Enterprise Server will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"tags": [
"apps"
],
@@ -5109,7 +5109,7 @@
"subcategoryLabel": "Oauth applications",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -5156,7 +5156,7 @@
}
],
"summary": "Revoke an authorization for an application",
"description": "**Deprecation Notice:** GitHub Enterprise Server will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.",
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.",
"tags": [
"apps"
],
@@ -5189,7 +5189,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a single token for an OAuth application. You must use <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password.</p>"
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a single token for an OAuth application. You must use <a href=\"https://docs.github.com/enterprise-server@2.20/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password.</p>"
},
{
"verb": "get",

16
lib/rest/static/decorated/ghes-2.21.json
View File

@@ -4626,7 +4626,7 @@
}
],
"summary": "Revoke a grant for an application",
"description": "**Deprecation Notice:** GitHub Enterprise Server will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server](https://github.com/settings/applications#authorized).",
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server](https://github.com/settings/applications#authorized).",
"tags": [
"apps"
],
@@ -4659,7 +4659,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. You must also provide a valid token as <code>:access_token</code> and the grant for the token's owner will be deleted.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on <a href=\"https://github.com/settings/applications#authorized\">the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server</a>.</p>"
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. You must also provide a valid token as <code>:access_token</code> and the grant for the token's owner will be deleted.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on <a href=\"https://github.com/settings/applications#authorized\">the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server</a>.</p>"
},
{
"verb": "post",
@@ -4999,7 +4999,7 @@
}
],
"summary": "Check an authorization",
"description": "**Deprecation Notice:** GitHub Enterprise Server will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"tags": [
"apps"
],
@@ -5025,7 +5025,7 @@
"subcategoryLabel": "Oauth applications",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -5077,7 +5077,7 @@
}
],
"summary": "Reset an authorization",
"description": "**Deprecation Notice:** GitHub Enterprise Server will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"tags": [
"apps"
],
@@ -5103,7 +5103,7 @@
"subcategoryLabel": "Oauth applications",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -5150,7 +5150,7 @@
}
],
"summary": "Revoke an authorization for an application",
"description": "**Deprecation Notice:** GitHub Enterprise Server will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.",
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.",
"tags": [
"apps"
],
@@ -5183,7 +5183,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a single token for an OAuth application. You must use <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password.</p>"
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a single token for an OAuth application. You must use <a href=\"https://docs.github.com/enterprise-server@2.21/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password.</p>"
},
{
"verb": "get",

51
lib/rest/static/decorated/ghes-2.22.json
View File

File diff suppressed because one or more lines are too long

16
lib/rest/static/decorated/github.ae.json
View File

@@ -3391,7 +3391,7 @@
}
],
"summary": "Revoke a grant for an application",
"description": "**Deprecation Notice:** GitHub AE will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub AE](https://github.com/settings/applications#authorized).",
"description": "**Deprecation Notice:** GitHub AE will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub AE](https://github.com/settings/applications#authorized).",
"tags": [
"apps"
],
@@ -3424,7 +3424,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub AE will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. You must also provide a valid token as <code>:access_token</code> and the grant for the token's owner will be deleted.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on <a href=\"https://github.com/settings/applications#authorized\">the Applications settings page under \"Authorized OAuth Apps\" on GitHub AE</a>.</p>"
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub AE will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. You must also provide a valid token as <code>:access_token</code> and the grant for the token's owner will be deleted.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on <a href=\"https://github.com/settings/applications#authorized\">the Applications settings page under \"Authorized OAuth Apps\" on GitHub AE</a>.</p>"
},
{
"verb": "post",
@@ -3764,7 +3764,7 @@
}
],
"summary": "Check an authorization",
"description": "**Deprecation Notice:** GitHub AE will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"description": "**Deprecation Notice:** GitHub AE will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"tags": [
"apps"
],
@@ -3790,7 +3790,7 @@
"subcategoryLabel": "Oauth applications",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub AE will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub AE will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -3842,7 +3842,7 @@
}
],
"summary": "Reset an authorization",
"description": "**Deprecation Notice:** GitHub AE will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"description": "**Deprecation Notice:** GitHub AE will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
"tags": [
"apps"
],
@@ -3868,7 +3868,7 @@
"subcategoryLabel": "Oauth applications",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub AE will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub AE will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -3915,7 +3915,7 @@
}
],
"summary": "Revoke an authorization for an application",
"description": "**Deprecation Notice:** GitHub AE will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.",
"description": "**Deprecation Notice:** GitHub AE will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.",
"tags": [
"apps"
],
@@ -3948,7 +3948,7 @@
}
],
"bodyParameters": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub AE will replace and discontinue OAuth endpoints containing <code>access_token</code> in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using <code>access_token</code> as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a single token for an OAuth application. You must use <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password.</p>"
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub AE will discontinue OAuth endpoints that contain <code>access_token</code> in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving <code>access_token</code> to the request body. For more information, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/\">blog post</a>.</p>\n<p>OAuth application owners can revoke a single token for an OAuth application. You must use <a href=\"https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password.</p>"
},
{
"verb": "get",