Update OpenAPI Descriptions (#25288)
This commit is contained in:
committed by
GitHub
parent
8bc6cdec10
commit
9dddf18eae
@@ -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": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/reactions/42</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /reactions/{reaction_id}', {\n reaction_id: 42\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /reactions/{reaction_id}'</span>, {\n <span class=\"hljs-attr\">reaction_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"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": "<p><strong>Deprecation Notice:</strong> 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 <a href=\"https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/\">blog post</a>.</p>\n<p>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>, when deleting a <a href=\"https://docs.github.com/rest/reference/teams#discussions\">team discussion</a> or <a href=\"https://docs.github.com/rest/reference/teams#discussion-comments\">team discussion comment</a>.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "304",
|
||||
"httpStatusMessage": "Not Modified",
|
||||
"description": "<p>Not modified</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "401",
|
||||
"httpStatusMessage": "Unauthorized",
|
||||
"description": "<p>Requires authentication</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "410",
|
||||
"httpStatusMessage": "Gone",
|
||||
"description": "<p>Gone</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}",
|
||||
|
||||
Reference in New Issue
Block a user