From e070137b12c9af9681d996007f452f935b1189e4 Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Tue, 28 Jun 2022 05:49:34 -0700 Subject: [PATCH] feat: add 11 new APIs and support for new `retention_period_minutes` request body parameter in Codespaces APIs (#406) feat: `PUT /enterprises/{enterprise}/actions/oidc/customization/issuer` feat: `GET /orgs/{org_id}/codespaces` feat: `POST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop` feat: `GET /orgs/{org}/actions/oidc/customization/sub` feat: `PUT /orgs/{org}/actions/oidc/customization/sub` feat: `DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}` feat: `GET /repos/{owner}/{repo}/actions/caches` feat: `DELETE /repos/{owner}/{repo}/actions/caches` feat: `DELETE /repos/{owner}/{repo}/actions/caches/{cache_id}` feat: `GET /repos/{owner}/{repo}/actions/oidc/customization/sub` feat: `PUT /repos/{owner}/{repo}/actions/oidc/customization/sub` feat: support for optional `retention_period_minutes` request body parameter in `POST /repos/{owner}/{repo}/codespaces` , `POST /repos/{owner}/{repo}/pulls/{pull_number} odespaces` and `POST /user/codespaces` --- package-lock.json | 14 +- package.json | 4 +- .../update-endpoints/generated/endpoints.json | 171 ++++++++++++++++++ src/generated/Endpoints.ts | 77 ++++++++ 4 files changed, 257 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index 5932fd341..0f9ba522d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^12.4.0" + "@octokit/openapi-types": "^12.5.0" }, "devDependencies": { "@pika/pack": "^0.5.0", @@ -1876,9 +1876,9 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "12.4.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-12.4.0.tgz", - "integrity": "sha512-Npcb7Pv30b33U04jvcD7l75yLU0mxhuX2Xqrn51YyZ5WTkF04bpbxLaZ6GcaTqu03WZQHoO/Gbfp95NGRueDUA==" + "version": "12.5.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-12.5.0.tgz", + "integrity": "sha512-VatvE5wtRkJq6hAWGTBZ62WkrdlCiy0G0u27cVOYTfAWVZi7QqTurVcjpsyc5+9hXLPRP5O/DaNEs4TgAp4Mqg==" }, "node_modules/@octokit/plugin-paginate-rest": { "version": "2.17.0", @@ -14473,9 +14473,9 @@ } }, "@octokit/openapi-types": { - "version": "12.4.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-12.4.0.tgz", - "integrity": "sha512-Npcb7Pv30b33U04jvcD7l75yLU0mxhuX2Xqrn51YyZ5WTkF04bpbxLaZ6GcaTqu03WZQHoO/Gbfp95NGRueDUA==" + "version": "12.5.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-12.5.0.tgz", + "integrity": "sha512-VatvE5wtRkJq6hAWGTBZ62WkrdlCiy0G0u27cVOYTfAWVZi7QqTurVcjpsyc5+9hXLPRP5O/DaNEs4TgAp4Mqg==" }, "@octokit/plugin-paginate-rest": { "version": "2.17.0", diff --git a/package.json b/package.json index b20f13d97..e29486af1 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ }, "description": "Shared TypeScript definitions for Octokit projects", "dependencies": { - "@octokit/openapi-types": "^12.4.0" + "@octokit/openapi-types": "^12.5.0" }, "scripts": { "build": "pika build", @@ -96,7 +96,7 @@ ] }, "octokit": { - "openapi-version": "6.1.0" + "openapi-version": "6.2.1" }, "renovate": { "extends": [ diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 7bec1d395..0f4abe20a 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -296,6 +296,31 @@ "previews": [], "renamed": null }, + { + "method": "DELETE", + "url": "/repos/{owner}/{repo}/actions/caches/{cache_id}", + "documentationUrl": "https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "owner" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "repo" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "cache_id" } + ], + "previews": [], + "renamed": null + }, + { + "method": "DELETE", + "url": "/repos/{owner}/{repo}/actions/caches{?key,ref}", + "documentationUrl": "https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "owner" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "repo" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "key" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "ref" } + ], + "previews": [], + "renamed": null + }, { "method": "DELETE", "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", @@ -537,6 +562,23 @@ "previews": [], "renamed": null }, + { + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/caches", + "documentationUrl": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "owner" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "repo" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "per_page" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "page" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "ref" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "key" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "sort" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "direction" } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/repos/{owner}/{repo}/actions/cache/usage", @@ -613,6 +655,17 @@ "previews": [], "renamed": null }, + { + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/oidc/customization/sub", + "documentationUrl": "https://docs.github.com/rest/actions/oidc#get-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "owner" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "repo" } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", @@ -1452,6 +1505,22 @@ "previews": [], "renamed": null }, + { + "method": "PUT", + "url": "/enterprises/{enterprise}/actions/oidc/customization/issuer", + "documentationUrl": "https://docs.github.com/rest/reference/actions/oidc#set-actions-oidc-custom-issuer-policy-for-enterprise", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "include_enterprise_slug" + } + ], + "previews": [], + "renamed": null + }, { "method": "PUT", "url": "/orgs/{org}/actions/permissions/selected-actions", @@ -1534,6 +1603,18 @@ "previews": [], "renamed": null }, + { + "method": "PUT", + "url": "/repos/{owner}/{repo}/actions/oidc/customization/sub", + "documentationUrl": "https://docs.github.com/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "owner" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "repo" }, + { "alias": null, "deprecated": null, "in": "BODY", "name": "use_default" } + ], + "previews": [], + "renamed": null + }, { "method": "PUT", "url": "/enterprises/{enterprise}/actions/permissions/workflow", @@ -3900,6 +3981,12 @@ "in": "BODY", "name": "display_name" }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "retention_period_minutes" + }, { "alias": null, "deprecated": null, @@ -4019,6 +4106,12 @@ "deprecated": null, "in": "BODY", "name": "display_name" + }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "retention_period_minutes" } ], "previews": [], @@ -4064,6 +4157,12 @@ "deprecated": null, "in": "BODY", "name": "display_name" + }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "retention_period_minutes" } ], "previews": [], @@ -4084,6 +4183,23 @@ "previews": [], "renamed": null }, + { + "method": "DELETE", + "url": "/orgs/{org}/members/{username}/codespaces/{codespace_name}", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "username" }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "codespace_name" + } + ], + "previews": [], + "renamed": null + }, { "method": "DELETE", "url": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", @@ -4223,6 +4339,18 @@ "previews": [], "renamed": null }, + { + "method": "GET", + "url": "/orgs/{org_id}/codespaces", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-in-organization", + "parameters": [ + { "alias": null, "deprecated": null, "in": "QUERY", "name": "per_page" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "page" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "org_id" } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/repos/{owner}/{repo}/codespaces", @@ -4355,6 +4483,23 @@ "previews": [], "renamed": null }, + { + "method": "POST", + "url": "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "username" }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "codespace_name" + } + ], + "previews": [], + "renamed": null + }, { "method": "PATCH", "url": "/user/codespaces/{codespace_name}", @@ -7620,6 +7765,32 @@ "previews": [], "renamed": null }, + { + "method": "GET", + "url": "/orgs/{org}/actions/oidc/customization/sub", + "documentationUrl": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" } + ], + "previews": [], + "renamed": null + }, + { + "method": "PUT", + "url": "/orgs/{org}/actions/oidc/customization/sub", + "documentationUrl": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "include_claim_keys" + } + ], + "previews": [], + "renamed": null + }, { "method": "PUT", "url": "/orgs/{org}/blocks/{username}", diff --git a/src/generated/Endpoints.ts b/src/generated/Endpoints.ts index 0ecccb054..926274942 100644 --- a/src/generated/Endpoints.ts +++ b/src/generated/Endpoints.ts @@ -341,6 +341,13 @@ export interface Endpoints { "/orgs/{org}/members/{username}", "delete" >; + /** + * @see https://docs.github.com/rest/reference/codespaces + */ + "DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}": Operation< + "/orgs/{org}/members/{username}/codespaces/{codespace_name}", + "delete" + >; /** * @see https://docs.github.com/rest/reference/orgs#remove-organization-membership-for-a-user */ @@ -492,6 +499,20 @@ export interface Endpoints { "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "delete" >; + /** + * @see https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id + */ + "DELETE /repos/{owner}/{repo}/actions/caches/{cache_id}": Operation< + "/repos/{owner}/{repo}/actions/caches/{cache_id}", + "delete" + >; + /** + * @see https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key + */ + "DELETE /repos/{owner}/{repo}/actions/caches{?key,ref}": Operation< + "/repos/{owner}/{repo}/actions/caches", + "delete" + >; /** * @see https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository */ @@ -1446,6 +1467,13 @@ export interface Endpoints { "/organizations/{organization_id}/custom_roles", "get" >; + /** + * @see https://docs.github.com/rest/reference/codespaces#list-in-organization + */ + "GET /orgs/{org_id}/codespaces": Operation< + "/orgs/{org_id}/codespaces", + "get" + >; /** * @see https://docs.github.com/rest/reference/orgs#get-an-organization */ @@ -1464,6 +1492,13 @@ export interface Endpoints { "/orgs/{org}/actions/cache/usage-by-repository", "get" >; + /** + * @see https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization + */ + "GET /orgs/{org}/actions/oidc/customization/sub": Operation< + "/orgs/{org}/actions/oidc/customization/sub", + "get" + >; /** * @see https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization */ @@ -2067,6 +2102,13 @@ export interface Endpoints { "/repos/{owner}/{repo}/actions/cache/usage", "get" >; + /** + * @see https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/caches": Operation< + "/repos/{owner}/{repo}/actions/caches", + "get" + >; /** * @see https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run */ @@ -2081,6 +2123,13 @@ export interface Endpoints { "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", "get" >; + /** + * @see https://docs.github.com/rest/actions/oidc#get-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/oidc/customization/sub": Operation< + "/repos/{owner}/{repo}/actions/oidc/customization/sub", + "get" + >; /** * @see https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository */ @@ -4457,6 +4506,13 @@ export interface Endpoints { * @see https://docs.github.com/rest/reference/orgs#create-an-organization-invitation */ "POST /orgs/{org}/invitations": Operation<"/orgs/{org}/invitations", "post">; + /** + * @see https://docs.github.com/rest/reference/codespaces + */ + "POST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": Operation< + "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop", + "post" + >; /** * @see https://docs.github.com/rest/reference/migrations#start-an-organization-migration */ @@ -5180,6 +5236,13 @@ export interface Endpoints { "/authorizations/clients/{client_id}/{fingerprint}", "put" >; + /** + * @see https://docs.github.com/rest/reference/actions/oidc#set-actions-oidc-custom-issuer-policy-for-enterprise + */ + "PUT /enterprises/{enterprise}/actions/oidc/customization/issuer": Operation< + "/enterprises/{enterprise}/actions/oidc/customization/issuer", + "put" + >; /** * @see https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-enterprise */ @@ -5265,6 +5328,13 @@ export interface Endpoints { "/notifications/threads/{thread_id}/subscription", "put" >; + /** + * @see https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization + */ + "PUT /orgs/{org}/actions/oidc/customization/sub": Operation< + "/orgs/{org}/actions/oidc/customization/sub", + "put" + >; /** * @see https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization */ @@ -5440,6 +5510,13 @@ export interface Endpoints { "/projects/{project_id}/collaborators/{username}", "put" >; + /** + * @see https://docs.github.com/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository + */ + "PUT /repos/{owner}/{repo}/actions/oidc/customization/sub": Operation< + "/repos/{owner}/{repo}/actions/oidc/customization/sub", + "put" + >; /** * @see https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository */