fix: description and response data types updates for code-scanning endpoints (#75)

Author: octokitbot

cache/openapi-schema.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "2.16.2",
+    "version": "2.16.3",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -18503,7 +18503,7 @@
     "/repos/{owner}/{repo}/code-scanning/sarifs": {
       "post": {
         "summary": "Upload an analysis as SARIF data",
-        "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"",
+        "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"",
         "operationId": "code-scanning/upload-sarif",
         "tags": ["code-scanning"],
         "externalDocs": {
@@ -18549,10 +18549,6 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "Response",
-            "content": { "application/json": { "schema": {} } }
-          },
           "202": {
             "description": "Response",
             "content": {
@@ -46782,7 +46778,12 @@
           "tool": {
             "$ref": "#/components/schemas/code-scanning-analysis-tool"
           },
-          "deletable": { "type": "boolean" }
+          "deletable": { "type": "boolean" },
+          "warning": {
+            "type": "string",
+            "description": "Warning generated when processing the analysis",
+            "example": "123 results were ignored"
+          }
         },
         "required": [
           "ref",
@@ -46797,7 +46798,8 @@
           "url",
           "sarif_id",
           "tool",
-          "deletable"
+          "deletable",
+          "warning"
         ]
       },
       "code-scanning-analysis-deletion": {
@@ -60662,7 +60664,8 @@
             "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
             "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
             "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
-            "deletable": true
+            "deletable": true,
+            "warning": ""
           },
           {
             "ref": "refs/heads/my-branch",
@@ -60681,7 +60684,8 @@
               "guid": null,
               "version": "1.2.0"
             },
-            "deletable": true
+            "deletable": true,
+            "warning": ""
           }
         ]
       },
@@ -60700,7 +60704,8 @@
           "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
           "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6",
           "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" },
-          "deletable": true
+          "deletable": true,
+          "warning": ""
         }
       },
       "code-scanning-analysis-deletion": {

package.json

@@ -53,7 +53,7 @@
     ]
   },
   "octokit": {
-    "openapi-version": "2.16.2"
+    "openapi-version": "2.16.3"
   },
   "@pika/pack": {
     "pipeline": [

src/generated/types.ts

@@ -2611,10 +2611,10 @@ export interface paths {
      * You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:
      *
      * ```
-     * gzip -c analysis-data.sarif | base64
+     * gzip -c analysis-data.sarif | base64 -w0
      * ```
      *
-     * SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
+     * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
      *
      * The `202 Accepted`, response includes an `id` value.
      * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.
@@ -7925,6 +7925,8 @@ export interface components {
       sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"];
       tool: components["schemas"]["code-scanning-analysis-tool"];
       deletable: boolean;
+      /** Warning generated when processing the analysis */
+      warning: string;
     };
     /** Successful deletion of a code scanning analysis */
     "code-scanning-analysis-deletion": {
@@ -20786,10 +20788,10 @@ export interface operations {
    * You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:
    *
    * ```
-   * gzip -c analysis-data.sarif | base64
+   * gzip -c analysis-data.sarif | base64 -w0
    * ```
    *
-   * SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
+   * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
    *
    * The `202 Accepted`, response includes an `id` value.
    * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.
@@ -20803,12 +20805,6 @@ export interface operations {
       };
     };
     responses: {
-      /** Response */
-      200: {
-        content: {
-          "application/json": { [key: string]: any };
-        };
-      };
       /** Response */
       202: {
         content: {