From 9dddf18eae5c109a8913627c2bfb4bba4967487e Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Fri, 11 Feb 2022 12:15:59 -0600 Subject: [PATCH] Update OpenAPI Descriptions (#25288) --- lib/rest/static/decorated/api.github.com.json | 80 ------------ lib/rest/static/decorated/github.ae.json | 80 ------------ .../dereferenced/api.github.com.deref.json | 119 ------------------ .../static/dereferenced/github.ae.deref.json | 119 ------------------ 4 files changed, 398 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 76b56df4fd..3cfcfdb339 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -34221,86 +34221,6 @@ } ] }, - { - "verb": "delete", - "requestPath": "/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "reaction_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/reactions/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/reactions/42
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('DELETE /reactions/{reaction_id}', {\n reaction_id: 42\n})", - "html": "
await octokit.request('DELETE /reactions/{reaction_id}', {\n  reaction_id: 42\n})\n
" - } - ], - "summary": "Delete a reaction (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments).", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": null - }, - "deprecated": true, - "slug": "delete-a-reaction-legacy", - "category": "reactions", - "categoryLabel": "Reactions", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this blog post.

\n

OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.

", - "responses": [ - { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "

Response

" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "

Gone

" - } - ] - }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index a2ffaff8ed..99d15bcf4c 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -24966,86 +24966,6 @@ } ] }, - { - "verb": "delete", - "requestPath": "/reactions/{reaction_id}", - "serverUrl": "https://{hostname}/api/v3", - "parameters": [ - { - "name": "reaction_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/reactions/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/reactions/42
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('DELETE /reactions/{reaction_id}', {\n reaction_id: 42\n})", - "html": "
await octokit.request('DELETE /reactions/{reaction_id}', {\n  reaction_id: 42\n})\n
" - } - ], - "summary": "Delete a reaction (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments).", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-a-reaction-legacy" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": null - }, - "deprecated": true, - "slug": "delete-a-reaction-legacy", - "category": "reactions", - "categoryLabel": "Reactions", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this blog post.

\n

OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.

", - "responses": [ - { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "

Response

" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "

Gone

" - } - ] - }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index d3eee146e8..16f9f63854 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -125023,125 +125023,6 @@ } } }, - "/reactions/{reaction_id}": { - "delete": { - "summary": "Delete a reaction (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments).", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy" - }, - "parameters": [ - { - "name": "reaction_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": null - }, - "deprecated": true - } - }, "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository", diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 2dbc75a754..05a7106f3c 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -77292,125 +77292,6 @@ } } }, - "/reactions/{reaction_id}": { - "delete": { - "summary": "Delete a reaction (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments).", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-a-reaction-legacy" - }, - "parameters": [ - { - "name": "reaction_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": null - }, - "deprecated": true - } - }, "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository",