Update OpenAPI 3.1 Descriptions

github · Oct 31, 2024 · 52854ac · 52854ac
1 parent c8e5a99
commit 52854ac
Show file tree

Hide file tree

Showing 16 changed files with 1,028 additions and 32 deletions.
diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json
@@ -33314,7 +33314,7 @@
     "/repos/{owner}/{repo}/code-scanning/codeql/databases": {
       "get": {
         "summary": "List CodeQL databases for a repository",
-        "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+        "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
         "tags": [
           "code-scanning"
         ],
@@ -33374,7 +33374,7 @@
     "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
       "get": {
         "summary": "Get a CodeQL database for a repository",
-        "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+        "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
         "tags": [
           "code-scanning"
         ],
@@ -33434,6 +33434,58 @@
           "enabledForGitHubApps": true,
           "previews": [
 
+          ],
+          "category": "code-scanning",
+          "subcategory": "code-scanning"
+        }
+      },
+      "delete": {
+        "summary": "Delete a CodeQL database",
+        "description": "Deletes a CodeQL database for a language in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+        "tags": [
+          "code-scanning"
+        ],
+        "operationId": "code-scanning/delete-codeql-database",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/owner"
+          },
+          {
+            "$ref": "#/components/parameters/repo"
+          },
+          {
+            "name": "language",
+            "in": "path",
+            "description": "The language of the CodeQL database.",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Response"
+          },
+          "403": {
+            "$ref": "#/components/responses/code_scanning_forbidden_write"
+          },
+          "404": {
+            "$ref": "#/components/responses/not_found"
+          },
+          "503": {
+            "$ref": "#/components/responses/service_unavailable"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "previews": [
+
           ],
           "category": "code-scanning",
           "subcategory": "code-scanning"