feat: add support for returning dependency_snapshots-specific rate …

…limits in `GET /rate_limit` (see PR description for additional `fix`) (#193)
octokit · Jul 5, 2022 · d402a68 · d402a68
1 parent f300f8a
commit d402a68
Show file tree

Hide file tree

Showing 17 changed files with 43 additions and 35 deletions.
diff --git a/cache/api.github.com.json b/cache/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" },
@@ -16944,7 +16944,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": {
@@ -17006,7 +17006,7 @@
  },
  "x-github": {
  "githubCloudOnly": false,
- "enabledForGitHubApps": true,
+ "enabledForGitHubApps": false,
  "category": "actions",
  "subcategory": "workflow-runs"
  },
@@ -52557,7 +52557,10 @@
  "actions_runner_registration": {
  "$ref": "#/components/schemas/rate-limit"
  },
- "scim": { "$ref": "#/components/schemas/rate-limit" }
+ "scim": { "$ref": "#/components/schemas/rate-limit" },
+ "dependency_snapshots": {
+ "$ref": "#/components/schemas/rate-limit"
+ }
  },
  "required": ["core", "search"]
  },

diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.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" },
@@ -15181,7 +15181,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": {
@@ -15243,7 +15243,7 @@
  },
  "x-github": {
  "githubCloudOnly": false,
- "enabledForGitHubApps": true,
+ "enabledForGitHubApps": false,
  "category": "actions",
  "subcategory": "workflow-runs"
  },

diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.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" },
@@ -14811,7 +14811,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": {
@@ -14873,7 +14873,7 @@
  },
  "x-github": {
  "githubCloudOnly": false,
- "enabledForGitHubApps": true,
+ "enabledForGitHubApps": false,
  "category": "actions",
  "subcategory": "workflow-runs"
  },

diff --git a/cache/ghes-3.4.json b/cache/ghes-3.4.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" },
@@ -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"
  },

diff --git a/cache/ghes-3.5.json b/cache/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"
  },

diff --git a/cache/github.ae.json b/cache/github.ae.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" },
@@ -11635,7 +11635,9 @@
  "category": "rate-limit",
  "subcategory": null
  },
- "x-octokit": {}
+ "x-octokit": {
+ "diff": { "api.github.com.json": { "type": "changed" } }
+ }
  }
  },
  "/repos/{owner}/{repo}": {

diff --git a/packages/openapi-types-ghes-3.2/package.json b/packages/openapi-types-ghes-3.2/package.json
@@ -12,5 +12,5 @@
  "types": "types.d.ts",
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
- "octokit": { "openapi-version": "6.4.0" }
+ "octokit": { "openapi-version": "6.5.0" }
 }
diff --git a/packages/openapi-types-ghes-3.2/types.d.ts b/packages/openapi-types-ghes-3.2/types.d.ts
@@ -1801,7 +1801,7 @@ export interface paths {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  post: operations["actions/review-pending-deployments-for-run"];
  };
@@ -18916,7 +18916,7 @@ export interface operations {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  "actions/review-pending-deployments-for-run": {
  parameters: {

diff --git a/packages/openapi-types-ghes-3.3/package.json b/packages/openapi-types-ghes-3.3/package.json
@@ -12,5 +12,5 @@
  "types": "types.d.ts",
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
- "octokit": { "openapi-version": "6.4.0" }
+ "octokit": { "openapi-version": "6.5.0" }
 }
diff --git a/packages/openapi-types-ghes-3.3/types.d.ts b/packages/openapi-types-ghes-3.3/types.d.ts
@@ -1818,7 +1818,7 @@ export interface paths {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  post: operations["actions/review-pending-deployments-for-run"];
  };
@@ -19402,7 +19402,7 @@ export interface operations {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  "actions/review-pending-deployments-for-run": {
  parameters: {

diff --git a/packages/openapi-types-ghes-3.4/package.json b/packages/openapi-types-ghes-3.4/package.json
@@ -12,5 +12,5 @@
  "types": "types.d.ts",
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
- "octokit": { "openapi-version": "6.4.0" }
+ "octokit": { "openapi-version": "6.5.0" }
 }
diff --git a/packages/openapi-types-ghes-3.4/types.d.ts b/packages/openapi-types-ghes-3.4/types.d.ts
@@ -2067,7 +2067,7 @@ export interface paths {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  post: operations["actions/review-pending-deployments-for-run"];
  };
@@ -20617,7 +20617,7 @@ export interface operations {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  "actions/review-pending-deployments-for-run": {
  parameters: {

diff --git a/packages/openapi-types-ghes-3.5/package.json b/packages/openapi-types-ghes-3.5/package.json
@@ -12,5 +12,5 @@
  "types": "types.d.ts",
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
- "octokit": { "openapi-version": "6.4.0" }
+ "octokit": { "openapi-version": "6.5.0" }
 }
diff --git a/packages/openapi-types-ghes-3.5/types.d.ts b/packages/openapi-types-ghes-3.5/types.d.ts
@@ -2191,7 +2191,7 @@ export interface paths {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  post: operations["actions/review-pending-deployments-for-run"];
  };
@@ -21860,7 +21860,7 @@ export interface operations {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  "actions/review-pending-deployments-for-run": {
  parameters: {

diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json
@@ -12,5 +12,5 @@
  "types": "types.d.ts",
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
- "octokit": { "openapi-version": "6.4.0" }
+ "octokit": { "openapi-version": "6.5.0" }
 }
diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json
@@ -12,5 +12,5 @@
  "types": "types.d.ts",
  "author": "Gregor Martynus (https://twitter.com/gr2m)",
  "license": "MIT",
- "octokit": { "openapi-version": "6.4.0" }
+ "octokit": { "openapi-version": "6.5.0" }
 }
diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts
@@ -2513,7 +2513,7 @@ export interface paths {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  post: operations["actions/review-pending-deployments-for-run"];
  };
@@ -9416,6 +9416,7 @@ export interface components {
  code_scanning_upload?: components["schemas"]["rate-limit"];
  actions_runner_registration?: components["schemas"]["rate-limit"];
  scim?: components["schemas"]["rate-limit"];
+ dependency_snapshots?: components["schemas"]["rate-limit"];
  };
  rate: components["schemas"]["rate-limit"];
  };
@@ -23938,7 +23939,7 @@ export interface operations {
  /**
  * Approve or reject pending deployments that are waiting on approval by a required reviewer.
  *
- * Anyone with read access to the repository contents and deployments can use this endpoint.
+ * Required 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.
  */
  "actions/review-pending-deployments-for-run": {
  parameters: {