@octokit/openapi 6.3.0 → 6.5.0

package/generated/ghes-3.4.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.3.0",
+    "version": "6.5.0",
     "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" },
@@ -112130,7 +112130,7 @@
       },
       "post": {
         "summary": "Review pending deployments for a workflow run",
-        "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.",
+        "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.",
         "tags": ["actions"],
         "operationId": "actions/review-pending-deployments-for-run",
         "externalDocs": {
@@ -112667,7 +112667,7 @@
         },
         "x-github": {
           "githubCloudOnly": false,
-          "enabledForGitHubApps": true,
+          "enabledForGitHubApps": false,
           "category": "actions",
           "subcategory": "workflow-runs"
         },
@@ -145443,7 +145443,7 @@
         "operationId": "code-scanning/list-alerts-for-repo",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository"
+          "url": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository"
         },
         "parameters": [
           {
@@ -145516,13 +145516,13 @@
           },
           {
             "name": "sort",
-            "description": "The property by which to sort the results.",
+            "description": "The property by which to sort the results. `number` is deprecated - we recommend that you use `created` instead.",
             "in": "query",
             "required": false,
             "schema": {
               "type": "string",
-              "enum": ["created", "updated", "number"],
-              "default": "number"
+              "enum": ["created", "number", "updated"],
+              "default": "created"
             }
           },
           {
@@ -145715,6 +145715,12 @@
                           "used in tests"
                         ]
                       },
+                      "dismissed_comment": {
+                        "type": "string",
+                        "description": "The dismissal comment associated with the dismissal of the alert.",
+                        "nullable": true,
+                        "maxLength": 280
+                      },
                       "rule": {
                         "type": "object",
                         "properties": {
@@ -145847,6 +145853,7 @@
                         "dismissed_by": null,
                         "dismissed_at": null,
                         "dismissed_reason": null,
+                        "dismissed_comment": null,
                         "rule": {
                           "id": "js/zipslip",
                           "severity": "error",
@@ -145908,6 +145915,7 @@
                         },
                         "dismissed_at": "2020-02-14T12:29:18Z",
                         "dismissed_reason": "false positive",
+                        "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
                         "rule": {
                           "id": "js/zipslip",
                           "severity": "error",
@@ -147582,7 +147590,6 @@
           "200": {
             "description": "Response",
             "content": {
-              "application/json+sarif": { "schema": { "type": "string" } },
               "application/json": {
                 "schema": {
                   "type": "object",
@@ -147688,7 +147695,7 @@
                 },
                 "examples": {
                   "response": {
-                    "summary": "Default response",
+                    "summary": "application/json response",
                     "value": {
                       "ref": "refs/heads/main",
                       "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
@@ -147712,6 +147719,54 @@
                     }
                   }
                 }
+              },
+              "application/json+sarif": {
+                "schema": { "type": "object", "additionalProperties": true },
+                "examples": {
+                  "response": {
+                    "summary": "application/json+sarif response",
+                    "value": {
+                      "runs": [
+                        {
+                          "tool": {
+                            "driver": {
+                              "name": "CodeQL",
+                              "organization": "GitHub",
+                              "semanticVersion": "1.0.0",
+                              "rules": [
+                                {
+                                  "id": "js/unused-local-variable",
+                                  "name": "js/unused-local-variable"
+                                }
+                              ]
+                            }
+                          },
+                          "results": [
+                            {
+                              "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38",
+                              "message": { "text": "Unused variable foo." },
+                              "locations": [
+                                {
+                                  "physicalLocation": {
+                                    "artifactLocation": { "uri": "file1.js" },
+                                    "region": { "startLine": 1 }
+                                  }
+                                }
+                              ],
+                              "ruleId": "js/unused-local-variable",
+                              "properties": [
+                                { "github/alertNumber": 2 },
+                                {
+                                  "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2"
+                                }
+                              ]
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                  }
+                }
               }
             }
           },
@@ -148013,6 +148068,15 @@
                   }
                 },
                 "required": ["commit_sha", "ref", "sarif"]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da",
+                    "ref": "refs/heads/master",
+                    "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA"
+                  }
+                }
               }
             }
           }

package/generated/ghes-3.4.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.3.0",
+    "version": "6.5.0",
     "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" },
@@ -16045,7 +16045,7 @@
       },
       "post": {
         "summary": "Review pending deployments for a workflow run",
-        "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.",
+        "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.",
         "tags": ["actions"],
         "operationId": "actions/review-pending-deployments-for-run",
         "externalDocs": {
@@ -16107,7 +16107,7 @@
         },
         "x-github": {
           "githubCloudOnly": false,
-          "enabledForGitHubApps": true,
+          "enabledForGitHubApps": false,
           "category": "actions",
           "subcategory": "workflow-runs"
         },
@@ -19908,7 +19908,7 @@
         "operationId": "code-scanning/list-alerts-for-repo",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository"
+          "url": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository"
         },
         "parameters": [
           { "$ref": "#/components/parameters/owner" },
@@ -19921,13 +19921,13 @@
           { "$ref": "#/components/parameters/direction" },
           {
             "name": "sort",
-            "description": "The property by which to sort the results.",
+            "description": "The property by which to sort the results. . `number` is deprecated - we recommend that you use `created` instead.",
             "in": "query",
             "required": false,
             "schema": {
               "type": "string",
-              "enum": ["created", "updated", "number"],
-              "default": "number"
+              "enum": ["created", "number", "updated"],
+              "default": "created"
             }
           },
           {
@@ -20254,7 +20254,6 @@
           "200": {
             "description": "Response",
             "content": {
-              "application/json+sarif": { "schema": { "type": "string" } },
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/code-scanning-analysis"
@@ -20264,6 +20263,14 @@
                     "$ref": "#/components/examples/code-scanning-analysis-default"
                   }
                 }
+              },
+              "application/json+sarif": {
+                "schema": { "type": "object", "additionalProperties": true },
+                "examples": {
+                  "response": {
+                    "$ref": "#/components/examples/code-scanning-analysis-sarif"
+                  }
+                }
               }
             }
           },
@@ -20383,6 +20390,15 @@
                   }
                 },
                 "required": ["commit_sha", "ref", "sarif"]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da",
+                    "ref": "refs/heads/master",
+                    "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA"
+                  }
+                }
               }
             }
           }
@@ -66131,7 +66147,7 @@
         ]
       },
       "code-scanning-analysis-default": {
-        "summary": "Default response",
+        "summary": "application/json response",
         "value": {
           "ref": "refs/heads/main",
           "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
@@ -66150,6 +66166,49 @@
           "warning": ""
         }
       },
+      "code-scanning-analysis-sarif": {
+        "summary": "application/json+sarif response",
+        "value": {
+          "runs": [
+            {
+              "tool": {
+                "driver": {
+                  "name": "CodeQL",
+                  "organization": "GitHub",
+                  "semanticVersion": "1.0.0",
+                  "rules": [
+                    {
+                      "id": "js/unused-local-variable",
+                      "name": "js/unused-local-variable"
+                    }
+                  ]
+                }
+              },
+              "results": [
+                {
+                  "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38",
+                  "message": { "text": "Unused variable foo." },
+                  "locations": [
+                    {
+                      "physicalLocation": {
+                        "artifactLocation": { "uri": "file1.js" },
+                        "region": { "startLine": 1 }
+                      }
+                    }
+                  ],
+                  "ruleId": "js/unused-local-variable",
+                  "properties": [
+                    { "github/alertNumber": 2 },
+                    {
+                      "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2"
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      },
       "code-scanning-analysis-deletion": {
         "summary": "Default response",
         "value": {

package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json

@@ -9227,6 +9227,33 @@
           }
         }
       },
+      "/rate_limit": {
+        "get": {
+          "responses": {
+            "changed": {
+              "200": {
+                "content": {
+                  "changed": {
+                    "application/json": {
+                      "schema_changed": {
+                        "properties_changed": {
+                          "changed": {
+                            "resources": {
+                              "properties_changed": {
+                                "removed": ["dependency_snapshots"]
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
       "/repos/{owner}/{repo}": {
         "get": {
           "responses": {
@@ -10033,29 +10060,6 @@
           }
         }
       },
-      "/repos/{owner}/{repo}/code-scanning/alerts": {
-        "get": {
-          "responses": {
-            "changed": {
-              "200": {
-                "content": {
-                  "changed": {
-                    "application/json": {
-                      "schema_changed": {
-                        "items_changed": {
-                          "properties_changed": {
-                            "removed": ["dismissed_comment"]
-                          }
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      },
       "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": {
         "get": {
           "responses": {
@@ -10451,6 +10455,17 @@
           }
         },
         "post": {
+          "request_body": {
+            "content_changed": {
+              "changed": {
+                "application/json": {
+                  "schema_changed": {
+                    "properties_changed": { "removed": ["name"] }
+                  }
+                }
+              }
+            }
+          },
           "responses": {
             "changed": {
               "202": {