@octokit/openapi 6.4.0 → 6.5.0

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

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.4.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" },
@@ -4802,6 +4802,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/enterprise-server@3.5/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",
@@ -14632,6 +14684,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",
@@ -18241,6 +18322,17 @@
         ],
         "nullable": true
       },
+      "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",
@@ -22436,6 +22528,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": {
@@ -29429,6 +29563,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": {

package/generated/ghes-3.5.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.4.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" },
@@ -94387,7 +94387,7 @@
           "category": "rate-limit",
           "subcategory": null
         },
-        "x-octokit": {}
+        "x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
       }
     },
     "/repos/{owner}/{repo}": {
@@ -118623,7 +118623,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": {
@@ -119160,7 +119160,7 @@
         },
         "x-github": {
           "githubCloudOnly": false,
-          "enabledForGitHubApps": true,
+          "enabledForGitHubApps": false,
           "category": "actions",
           "subcategory": "workflow-runs"
         },

package/generated/ghes-3.5.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.4.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"
         },

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": {

package/generated/github.ae-diff-to-api.github.com.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.4.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",