@octokit/openapi 6.3.0 → 6.5.0

package/generated/ghes-3.5.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" },
@@ -14989,7 +14989,9 @@
           "category": "rate-limit",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
       }
     },
     "/repos/{owner}/{repo}": {
@@ -16884,7 +16886,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": {
@@ -16946,7 +16948,7 @@
         },
         "x-github": {
           "githubCloudOnly": false,
-          "enabledForGitHubApps": true,
+          "enabledForGitHubApps": false,
           "category": "actions",
           "subcategory": "workflow-runs"
         },
@@ -20809,7 +20811,7 @@
         "operationId": "code-scanning/list-alerts-for-repo",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.5/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" },
@@ -20822,13 +20824,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"
             }
           },
           {
@@ -20873,9 +20875,7 @@
           "category": "code-scanning",
           "subcategory": null
         },
-        "x-octokit": {
-          "diff": { "api.github.com.json": { "type": "changed" } }
-        }
+        "x-octokit": {}
       }
     },
     "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": {
@@ -21160,7 +21160,6 @@
           "200": {
             "description": "Response",
             "content": {
-              "application/json+sarif": { "schema": { "type": "string" } },
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/code-scanning-analysis"
@@ -21170,6 +21169,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"
+                  }
+                }
               }
             }
           },
@@ -21289,6 +21296,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"
+                  }
+                }
               }
             }
           }
@@ -70021,7 +70037,7 @@
         ]
       },
       "code-scanning-analysis-default": {
-        "summary": "Default response",
+        "summary": "application/json response",
         "value": {
           "ref": "refs/heads/main",
           "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
@@ -70040,6 +70056,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/github.ae-anicca-diff-to-api.github.com.deref.json

@@ -5924,6 +5924,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": {
@@ -6691,13 +6718,13 @@
                 "style": "form"
               },
               {
-                "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",
                 "name": "sort",
                 "required": false,
                 "schema": {
-                  "default": "number",
-                  "enum": ["created", "updated", "number"],
+                  "default": "created",
+                  "enum": ["created", "number", "updated"],
                   "type": "string"
                 },
                 "style": "form"
@@ -7165,6 +7192,17 @@
           }
         },
         "post": {
+          "request_body": {
+            "content_changed": {
+              "changed": {
+                "application/json": {
+                  "schema_changed": {
+                    "properties_changed": { "removed": ["name"] }
+                  }
+                }
+              }
+            }
+          },
           "responses": {
             "changed": {
               "202": {

package/generated/github.ae-diff-to-api.github.com.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" },
@@ -32191,6 +32191,225 @@
         "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
       }
     },
+    "/rate_limit": {
+      "get": {
+        "summary": "Get rate limit status for the authenticated user",
+        "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
+        "tags": ["rate-limit"],
+        "operationId": "rate-limit/get",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/github-ae@latest/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user"
+        },
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Rate Limit Overview",
+                  "description": "Rate Limit Overview",
+                  "type": "object",
+                  "properties": {
+                    "resources": {
+                      "type": "object",
+                      "properties": {
+                        "core": {
+                          "title": "Rate Limit",
+                          "type": "object",
+                          "properties": {
+                            "limit": { "type": "integer" },
+                            "remaining": { "type": "integer" },
+                            "reset": { "type": "integer" },
+                            "used": { "type": "integer" }
+                          },
+                          "required": ["limit", "remaining", "reset", "used"]
+                        },
+                        "graphql": {
+                          "title": "Rate Limit",
+                          "type": "object",
+                          "properties": {
+                            "limit": { "type": "integer" },
+                            "remaining": { "type": "integer" },
+                            "reset": { "type": "integer" },
+                            "used": { "type": "integer" }
+                          },
+                          "required": ["limit", "remaining", "reset", "used"]
+                        },
+                        "search": {
+                          "title": "Rate Limit",
+                          "type": "object",
+                          "properties": {
+                            "limit": { "type": "integer" },
+                            "remaining": { "type": "integer" },
+                            "reset": { "type": "integer" },
+                            "used": { "type": "integer" }
+                          },
+                          "required": ["limit", "remaining", "reset", "used"]
+                        },
+                        "source_import": {
+                          "title": "Rate Limit",
+                          "type": "object",
+                          "properties": {
+                            "limit": { "type": "integer" },
+                            "remaining": { "type": "integer" },
+                            "reset": { "type": "integer" },
+                            "used": { "type": "integer" }
+                          },
+                          "required": ["limit", "remaining", "reset", "used"]
+                        },
+                        "integration_manifest": {
+                          "title": "Rate Limit",
+                          "type": "object",
+                          "properties": {
+                            "limit": { "type": "integer" },
+                            "remaining": { "type": "integer" },
+                            "reset": { "type": "integer" },
+                            "used": { "type": "integer" }
+                          },
+                          "required": ["limit", "remaining", "reset", "used"]
+                        },
+                        "code_scanning_upload": {
+                          "title": "Rate Limit",
+                          "type": "object",
+                          "properties": {
+                            "limit": { "type": "integer" },
+                            "remaining": { "type": "integer" },
+                            "reset": { "type": "integer" },
+                            "used": { "type": "integer" }
+                          },
+                          "required": ["limit", "remaining", "reset", "used"]
+                        },
+                        "actions_runner_registration": {
+                          "title": "Rate Limit",
+                          "type": "object",
+                          "properties": {
+                            "limit": { "type": "integer" },
+                            "remaining": { "type": "integer" },
+                            "reset": { "type": "integer" },
+                            "used": { "type": "integer" }
+                          },
+                          "required": ["limit", "remaining", "reset", "used"]
+                        },
+                        "scim": {
+                          "title": "Rate Limit",
+                          "type": "object",
+                          "properties": {
+                            "limit": { "type": "integer" },
+                            "remaining": { "type": "integer" },
+                            "reset": { "type": "integer" },
+                            "used": { "type": "integer" }
+                          },
+                          "required": ["limit", "remaining", "reset", "used"]
+                        }
+                      },
+                      "required": ["core", "search"]
+                    },
+                    "rate": {
+                      "title": "Rate Limit",
+                      "type": "object",
+                      "properties": {
+                        "limit": { "type": "integer" },
+                        "remaining": { "type": "integer" },
+                        "reset": { "type": "integer" },
+                        "used": { "type": "integer" }
+                      },
+                      "required": ["limit", "remaining", "reset", "used"]
+                    }
+                  },
+                  "required": ["rate", "resources"]
+                },
+                "examples": {
+                  "default": {
+                    "value": {
+                      "resources": {
+                        "core": {
+                          "limit": 5000,
+                          "remaining": 4999,
+                          "reset": 1372700873,
+                          "used": 1
+                        },
+                        "search": {
+                          "limit": 30,
+                          "remaining": 18,
+                          "reset": 1372697452,
+                          "used": 12
+                        },
+                        "graphql": {
+                          "limit": 5000,
+                          "remaining": 4993,
+                          "reset": 1372700389,
+                          "used": 7
+                        },
+                        "integration_manifest": {
+                          "limit": 5000,
+                          "remaining": 4999,
+                          "reset": 1551806725,
+                          "used": 1
+                        },
+                        "code_scanning_upload": {
+                          "limit": 500,
+                          "remaining": 499,
+                          "reset": 1551806725,
+                          "used": 1
+                        }
+                      },
+                      "rate": {
+                        "limit": 5000,
+                        "remaining": 4999,
+                        "reset": 1372700873,
+                        "used": 1
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "headers": {
+              "X-RateLimit-Limit": {
+                "example": 5000,
+                "schema": { "type": "integer" }
+              },
+              "X-RateLimit-Remaining": {
+                "example": 4999,
+                "schema": { "type": "integer" }
+              },
+              "X-RateLimit-Reset": {
+                "example": 1590701888,
+                "schema": { "type": "integer", "format": "timestamp" }
+              }
+            }
+          },
+          "304": { "description": "Not modified" },
+          "404": {
+            "description": "Resource not found",
+            "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,
+          "category": "rate-limit",
+          "subcategory": null
+        },
+        "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
+      }
+    },
     "/repos/{owner}/{repo}": {
       "get": {
         "summary": "Get a repository",

package/generated/github.ae-diff-to-api.github.com.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" },
@@ -3679,6 +3679,58 @@
         }
       }
     },
+    "/rate_limit": {
+      "get": {
+        "summary": "Get rate limit status for the authenticated user",
+        "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
+        "tags": ["rate-limit"],
+        "operationId": "rate-limit/get",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/github-ae@latest/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user"
+        },
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/rate-limit-overview"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/rate-limit-overview"
+                  }
+                }
+              }
+            },
+            "headers": {
+              "X-RateLimit-Limit": {
+                "$ref": "#/components/headers/x-rate-limit-limit"
+              },
+              "X-RateLimit-Remaining": {
+                "$ref": "#/components/headers/x-rate-limit-remaining"
+              },
+              "X-RateLimit-Reset": {
+                "$ref": "#/components/headers/x-rate-limit-reset"
+              }
+            }
+          },
+          "304": { "$ref": "#/components/responses/not_modified" },
+          "404": { "$ref": "#/components/responses/not_found" }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "rate-limit",
+          "subcategory": null
+        },
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
+      }
+    },
     "/repos/{owner}/{repo}": {
       "get": {
         "summary": "Get a repository",
@@ -11281,6 +11333,35 @@
           "updated_at"
         ]
       },
+      "rate-limit-overview": {
+        "title": "Rate Limit Overview",
+        "description": "Rate Limit Overview",
+        "type": "object",
+        "properties": {
+          "resources": {
+            "type": "object",
+            "properties": {
+              "core": { "$ref": "#/components/schemas/rate-limit" },
+              "graphql": { "$ref": "#/components/schemas/rate-limit" },
+              "search": { "$ref": "#/components/schemas/rate-limit" },
+              "source_import": { "$ref": "#/components/schemas/rate-limit" },
+              "integration_manifest": {
+                "$ref": "#/components/schemas/rate-limit"
+              },
+              "code_scanning_upload": {
+                "$ref": "#/components/schemas/rate-limit"
+              },
+              "actions_runner_registration": {
+                "$ref": "#/components/schemas/rate-limit"
+              },
+              "scim": { "$ref": "#/components/schemas/rate-limit" }
+            },
+            "required": ["core", "search"]
+          },
+          "rate": { "$ref": "#/components/schemas/rate-limit" }
+        },
+        "required": ["rate", "resources"]
+      },
       "full-repository": {
         "title": "Full Repository",
         "description": "Full Repository",
@@ -14278,6 +14359,17 @@
         },
         "required": ["url", "html_url", "key", "name"]
       },
+      "rate-limit": {
+        "title": "Rate Limit",
+        "type": "object",
+        "properties": {
+          "limit": { "type": "integer" },
+          "remaining": { "type": "integer" },
+          "reset": { "type": "integer" },
+          "used": { "type": "integer" }
+        },
+        "required": ["limit", "remaining", "reset", "used"]
+      },
       "code-of-conduct-simple": {
         "title": "Code Of Conduct Simple",
         "description": "Code of Conduct Simple",
@@ -17732,6 +17824,48 @@
           "watchers": 1
         }
       },
+      "rate-limit-overview": {
+        "value": {
+          "resources": {
+            "core": {
+              "limit": 5000,
+              "remaining": 4999,
+              "reset": 1372700873,
+              "used": 1
+            },
+            "search": {
+              "limit": 30,
+              "remaining": 18,
+              "reset": 1372697452,
+              "used": 12
+            },
+            "graphql": {
+              "limit": 5000,
+              "remaining": 4993,
+              "reset": 1372700389,
+              "used": 7
+            },
+            "integration_manifest": {
+              "limit": 5000,
+              "remaining": 4999,
+              "reset": 1551806725,
+              "used": 1
+            },
+            "code_scanning_upload": {
+              "limit": 500,
+              "remaining": 499,
+              "reset": 1551806725,
+              "used": 1
+            }
+          },
+          "rate": {
+            "limit": 5000,
+            "remaining": 4999,
+            "reset": 1372700873,
+            "used": 1
+          }
+        }
+      },
       "full-repository-default-response": {
         "summary": "Default response",
         "value": {
@@ -24333,6 +24467,18 @@
       "link": {
         "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
         "schema": { "type": "string" }
+      },
+      "x-rate-limit-limit": {
+        "example": 5000,
+        "schema": { "type": "integer" }
+      },
+      "x-rate-limit-remaining": {
+        "example": 4999,
+        "schema": { "type": "integer" }
+      },
+      "x-rate-limit-reset": {
+        "example": 1590701888,
+        "schema": { "type": "integer", "format": "timestamp" }
       }
     },
     "responses": {