From 9550ae9bf814fd77bf2bfe859228951aec879210 Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Tue, 27 Sep 2022 19:44:53 +0100 Subject: [PATCH 1/6] fix(deps): bump @octokit/openapi-types to v14.0.0 --- package-lock.json | 28 +++++++++++++++++++++------- package.json | 2 +- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/package-lock.json b/package-lock.json index dd2e52e96..e1639e2aa 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^13.11.0" + "@octokit/openapi-types": "^14.0.0" }, "devDependencies": { "@pika/pack": "^0.3.7", @@ -1938,9 +1938,9 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "13.12.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-13.12.0.tgz", - "integrity": "sha512-1QYzZrwnn3rTQE7ZoSxXrO8lhu0aIbac1c+qIPOPEaVXBWSaUyLV1x9yt4uDQOwmu6u5ywVS8OJgs+ErDLf6vQ==" + "version": "14.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-14.0.0.tgz", + "integrity": "sha512-HNWisMYlR8VCnNurDU6os2ikx0s0VyEjDYHNS/h4cgb8DeOxQ0n72HyinUtdDVxJhFy3FWLGl0DJhfEWk3P5Iw==" }, "node_modules/@octokit/plugin-paginate-rest": { "version": "4.3.1", @@ -2037,6 +2037,12 @@ "@octokit/openapi-types": "^13.11.0" } }, + "node_modules/@octokit/types/node_modules/@octokit/openapi-types": { + "version": "13.12.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-13.12.0.tgz", + "integrity": "sha512-1QYzZrwnn3rTQE7ZoSxXrO8lhu0aIbac1c+qIPOPEaVXBWSaUyLV1x9yt4uDQOwmu6u5ywVS8OJgs+ErDLf6vQ==", + "dev": true + }, "node_modules/@pika/babel-plugin-esm-import-rewrite": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/@pika/babel-plugin-esm-import-rewrite/-/babel-plugin-esm-import-rewrite-0.6.1.tgz", @@ -12410,9 +12416,9 @@ } }, "@octokit/openapi-types": { - "version": "13.12.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-13.12.0.tgz", - "integrity": "sha512-1QYzZrwnn3rTQE7ZoSxXrO8lhu0aIbac1c+qIPOPEaVXBWSaUyLV1x9yt4uDQOwmu6u5ywVS8OJgs+ErDLf6vQ==" + "version": "14.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-14.0.0.tgz", + "integrity": "sha512-HNWisMYlR8VCnNurDU6os2ikx0s0VyEjDYHNS/h4cgb8DeOxQ0n72HyinUtdDVxJhFy3FWLGl0DJhfEWk3P5Iw==" }, "@octokit/plugin-paginate-rest": { "version": "4.3.1", @@ -12484,6 +12490,14 @@ "dev": true, "requires": { "@octokit/openapi-types": "^13.11.0" + }, + "dependencies": { + "@octokit/openapi-types": { + "version": "13.12.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-13.12.0.tgz", + "integrity": "sha512-1QYzZrwnn3rTQE7ZoSxXrO8lhu0aIbac1c+qIPOPEaVXBWSaUyLV1x9yt4uDQOwmu6u5ywVS8OJgs+ErDLf6vQ==", + "dev": true + } } }, "@pika/babel-plugin-esm-import-rewrite": { diff --git a/package.json b/package.json index f16749cc5..5c43a226c 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ }, "description": "Shared TypeScript definitions for Octokit projects", "dependencies": { - "@octokit/openapi-types": "^13.11.0" + "@octokit/openapi-types": "^14.0.0" }, "scripts": { "build": "pika-pack build", From 945d8c30f181fb32035763de22c41203d2e9a8d0 Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Wed, 28 Sep 2022 12:15:53 +0100 Subject: [PATCH 2/6] chore: bump `octokit.openapi-version` in `package.json` to `8.0.0` --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5c43a226c..807c27212 100644 --- a/package.json +++ b/package.json @@ -96,6 +96,6 @@ ] }, "octokit": { - "openapi-version": "7.13.0" + "openapi-version": "8.0.0" } } From a5370ca125a0a3a6563fd50070074a6c3cff17b2 Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Wed, 28 Sep 2022 12:16:25 +0100 Subject: [PATCH 3/6] fix(build): don't show Enterprise Cloud in the documentation URLs now we're using the Enterprise Cloud schema --- scripts/update-endpoints/fetch-json.js | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/scripts/update-endpoints/fetch-json.js b/scripts/update-endpoints/fetch-json.js index d18d12307..40fdfe5f3 100644 --- a/scripts/update-endpoints/fetch-json.js +++ b/scripts/update-endpoints/fetch-json.js @@ -33,6 +33,14 @@ const QUERY = ` main(); +const removeEnterpriseCloudFromDocumentationUrl = (endpoint) => ({ + ...endpoint, + documentationUrl: endpoint.documentationUrl.replace( + "/enterprise-cloud@latest/", + "" + ), +}); + async function main() { const { data: { endpoints }, @@ -43,8 +51,11 @@ async function main() { writeFileSync( path.resolve(__dirname, "generated", "endpoints.json"), - prettier.format(JSON.stringify(endpoints), { - parser: "json", - }) + prettier.format( + JSON.stringify(endpoints.map(removeEnterpriseCloudFromDocumentationUrl)), + { + parser: "json", + } + ) ); } From 7a1ec1e10ef23ab96a546683b3697a8b5c8a3dbc Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Wed, 28 Sep 2022 12:17:15 +0100 Subject: [PATCH 4/6] chore: auto generate scripts/update-endpoints/generated/endpoints.json --- .../update-endpoints/generated/endpoints.json | 562 ++++++++---------- 1 file changed, 233 insertions(+), 329 deletions(-) diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 96c171dfc..5e9145452 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -3968,6 +3968,28 @@ "previews": [], "renamed": null }, + { + "method": "PUT", + "url": "/organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#add-selected-repository-to-an-organization-secret", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "secret_name" + }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "repository_id" + } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/user/codespaces/{codespace_name}/machines", @@ -4056,6 +4078,36 @@ "previews": [], "renamed": null }, + { + "method": "PUT", + "url": "/organizations/{org}/codespaces/secrets/{secret_name}", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "secret_name" + }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "encrypted_value" + }, + { "alias": null, "deprecated": null, "in": "BODY", "name": "key_id" }, + { "alias": null, "deprecated": null, "in": "BODY", "name": "visibility" }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "selected_repository_ids" + } + ], + "previews": [], + "renamed": null + }, { "method": "PUT", "url": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", @@ -4247,6 +4299,17 @@ "previews": [], "renamed": null }, + { + "method": "DELETE", + "url": "/organizations/{org}/codespaces/secrets/{secret_name}", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-an-organization-secret", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "secret_name" } + ], + "previews": [], + "renamed": null + }, { "method": "DELETE", "url": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", @@ -4315,6 +4378,27 @@ "previews": [], "renamed": null }, + { + "method": "GET", + "url": "/organizations/{org}/codespaces/secrets/public-key", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-an-organization-public-key", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" } + ], + "previews": [], + "renamed": null + }, + { + "method": "GET", + "url": "/organizations/{org}/codespaces/secrets/{secret_name}", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-an-organization-secret", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "secret_name" } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/user/codespaces/secrets/public-key", @@ -4412,6 +4496,18 @@ "previews": [], "renamed": null }, + { + "method": "GET", + "url": "/organizations/{org}/codespaces/secrets", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-organization-secrets", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "per_page" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "page" } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/repos/{owner}/{repo}/codespaces/secrets", @@ -4446,6 +4542,24 @@ "previews": [], "renamed": null }, + { + "method": "GET", + "url": "/organizations/{org}/codespaces/secrets/{secret_name}/repositories", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "secret_name" + }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "page" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "per_page" } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/repos/{owner}/{repo}/codespaces/new", @@ -4480,6 +4594,28 @@ "previews": [], "renamed": null }, + { + "method": "DELETE", + "url": "/organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "secret_name" + }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "repository_id" + } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/repos/{owner}/{repo}/codespaces/machines", @@ -4514,6 +4650,28 @@ "previews": [], "renamed": null }, + { + "method": "PUT", + "url": "/organizations/{org}/codespaces/secrets/{secret_name}/repositories", + "documentationUrl": "https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "org" }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "secret_name" + }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "selected_repository_ids" + } + ], + "previews": [], + "renamed": null + }, { "method": "POST", "url": "/user/codespaces/{codespace_name}/start", @@ -4688,6 +4846,23 @@ "previews": [], "renamed": null }, + { + "method": "GET", + "url": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-dependabot-alert", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "owner" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "repo" }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "alert_number" + } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/orgs/{org}/dependabot/secrets/public-key", @@ -4732,6 +4907,27 @@ "previews": [], "renamed": null }, + { + "method": "GET", + "url": "/repos/{owner}/{repo}/dependabot/alerts", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#list-dependabot-alerts-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": "state" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "severity" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "ecosystem" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "package" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "manifest" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "scope" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "sort" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "direction" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "page" }, + { "alias": null, "deprecated": null, "in": "QUERY", "name": "per_page" } + ], + "previews": [], + "renamed": null + }, { "method": "GET", "url": "/orgs/{org}/dependabot/secrets", @@ -4819,6 +5015,36 @@ "previews": [], "renamed": null }, + { + "method": "PATCH", + "url": "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", + "documentationUrl": "https://docs.github.com/rest/reference/dependabot#update-a-dependabot-alert", + "parameters": [ + { "alias": null, "deprecated": null, "in": "PATH", "name": "owner" }, + { "alias": null, "deprecated": null, "in": "PATH", "name": "repo" }, + { + "alias": null, + "deprecated": null, + "in": "PATH", + "name": "alert_number" + }, + { "alias": null, "deprecated": null, "in": "BODY", "name": "state" }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "dismissed_reason" + }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "dismissed_comment" + } + ], + "previews": [], + "renamed": null + }, { "method": "POST", "url": "/repos/{owner}/{repo}/dependency-graph/snapshots", @@ -5078,22 +5304,6 @@ "previews": [], "renamed": null }, - { - "method": "DELETE", - "url": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "PATH", - "name": "scim_group_id" - } - ], - "previews": [], - "renamed": null - }, { "method": "DELETE", "url": "/enterprises/{enterprise}/actions/runners/{runner_id}", @@ -5121,22 +5331,6 @@ "previews": [], "renamed": null }, - { - "method": "DELETE", - "url": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-user-from-an-enterprise", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "PATH", - "name": "scim_user_id" - } - ], - "previews": [], - "renamed": null - }, { "method": "DELETE", "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", @@ -5218,44 +5412,6 @@ "previews": [], "renamed": null }, - { - "method": "GET", - "url": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "PATH", - "name": "scim_group_id" - }, - { - "alias": null, - "deprecated": null, - "in": "QUERY", - "name": "excludedAttributes" - } - ], - "previews": [], - "renamed": null - }, - { - "method": "GET", - "url": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-user", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "PATH", - "name": "scim_user_id" - } - ], - "previews": [], - "renamed": null - }, { "method": "GET", "url": "/enterprises/{enterprise}/actions/runners/{runner_id}", @@ -5334,48 +5490,6 @@ "previews": [], "renamed": null }, - { - "method": "GET", - "url": "/scim/v2/enterprises/{enterprise}/Groups", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "QUERY", - "name": "startIndex" - }, - { "alias": null, "deprecated": null, "in": "QUERY", "name": "count" }, - { "alias": null, "deprecated": null, "in": "QUERY", "name": "filter" }, - { - "alias": null, - "deprecated": null, - "in": "QUERY", - "name": "excludedAttributes" - } - ], - "previews": [], - "renamed": null - }, - { - "method": "GET", - "url": "/scim/v2/enterprises/{enterprise}/Users", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "QUERY", - "name": "startIndex" - }, - { "alias": null, "deprecated": null, "in": "QUERY", "name": "count" }, - { "alias": null, "deprecated": null, "in": "QUERY", "name": "filter" } - ], - "previews": [], - "renamed": null - }, { "method": "GET", "url": "/enterprises/{enterprise}/actions/runners/downloads", @@ -5446,81 +5560,6 @@ "previews": [], "renamed": null }, - { - "method": "POST", - "url": "/scim/v2/enterprises/{enterprise}/Groups", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "schemas" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "displayName" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "members" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "members[].value" - } - ], - "previews": [], - "renamed": null - }, - { - "method": "POST", - "url": "/scim/v2/enterprises/{enterprise}/Users", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "schemas" }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "userName" }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "name" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "name.givenName" - }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "name.familyName" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "emails" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "emails[].value" - }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "emails[].type" - }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "emails[].primary" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "groups" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "groups[].value" - } - ], - "previews": [], - "renamed": null - }, { "method": "DELETE", "url": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels", @@ -5640,93 +5679,6 @@ "previews": [], "renamed": null }, - { - "method": "PUT", - "url": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "PATH", - "name": "scim_group_id" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "schemas" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "displayName" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "members" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "members[].value" - } - ], - "previews": [], - "renamed": null - }, - { - "method": "PUT", - "url": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-user", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "PATH", - "name": "scim_user_id" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "schemas" }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "userName" }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "name" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "name.givenName" - }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "name.familyName" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "emails" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "emails[].value" - }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "emails[].type" - }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "emails[].primary" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "groups" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "groups[].value" - } - ], - "previews": [], - "renamed": null - }, { "method": "PUT", "url": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", @@ -5782,60 +5734,6 @@ "previews": [], "renamed": null }, - { - "method": "PATCH", - "url": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "PATH", - "name": "scim_group_id" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "schemas" }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "Operations" }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "Operations[].op" - }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "Operations[].path" - }, - { - "alias": null, - "deprecated": null, - "in": "BODY", - "name": "Operations[].value" - } - ], - "previews": [], - "renamed": null - }, - { - "method": "PATCH", - "url": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-user", - "parameters": [ - { "alias": null, "deprecated": null, "in": "PATH", "name": "enterprise" }, - { - "alias": null, - "deprecated": null, - "in": "PATH", - "name": "scim_user_id" - }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "schemas" }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "Operations" } - ], - "previews": [], - "renamed": null - }, { "method": "PATCH", "url": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", @@ -14350,7 +14248,13 @@ "name": "alert_number" }, { "alias": null, "deprecated": null, "in": "BODY", "name": "state" }, - { "alias": null, "deprecated": null, "in": "BODY", "name": "resolution" } + { "alias": null, "deprecated": null, "in": "BODY", "name": "resolution" }, + { + "alias": null, + "deprecated": null, + "in": "BODY", + "name": "resolution_comment" + } ], "previews": [], "renamed": null From e3bb815ef52d99944e7eed371c1de708abb3f76b Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Wed, 28 Sep 2022 12:23:21 +0100 Subject: [PATCH 5/6] feat: add support for 10 new APIs and drop enterprise-level SCIM APIs which are only in GitHub Enterprise Server * feat: add support for new "Delete an organization secret" (`DELETE /organizations/{org}/codespaces/secrets/{secret_name}`) Codespaces API * feat: add support for new "Remove selected repository from an organization secret" (`DELETE /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`) Codespaces API * feat: add support for new "List organization secrets" (`GET /organizations/{org}/codespaces/secrets`) Codespaces API * feat: add support for new "Get an organization public key" (`GET /organizations/{org}/codespaces/secrets/public-key`) Codespaces API * feat: add support for new "Get an organization secret" (`GET /organizations/{org}/codespaces/secrets/{secret_name}` ) Codespaces API * feat: add support for new "List selected repositories for an organization secret" (`GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories`) Codespaces API * * feat: add support for new "Get a Dependabot alert" API (`GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`) * feat: add support for new "List Dependabot alerts for a repository" API (`GET /repos/{owner}/{repo}/dependabot/alerts`) * feat: add support for new "Update a Dependabot alert" API (`PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`) * feat: adds support for new "Create or update an organization secret" (`PUT /organizations/{org}/codespaces/secrets/{secret_name}` ) Codespaces API * feat: add support for new "List selected repositories for an organization secret" (`GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories`) Codespaces API * feat: add support for new "Add selected repository to an organization secret" (`PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`) Codespaces API BREAKING CHANGE: Removes support for enterprise-level SCIM APIs which are only available in GitHub Enterprise Server (`DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}`, `DELETE /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}`, `GET /scim/v2/enterprises/{enterprise}/Groups`, `GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}`, `GET /scim/v2/enterprises/{enterprise}/Users`, `GET /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}`, `PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}`, `PATCH /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}`, `POST /scim/v2/enterprises/{enterprise}/Groups`, `POST /scim/v2/enterprises/{enterprise}/Users`, `PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}`, `PUT /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}`) # Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # # On branch timrogers/manual-update --- src/generated/Endpoints.ts | 168 ++++++++++++++++++------------------- 1 file changed, 84 insertions(+), 84 deletions(-) diff --git a/src/generated/Endpoints.ts b/src/generated/Endpoints.ts index be2030928..db196f5ae 100644 --- a/src/generated/Endpoints.ts +++ b/src/generated/Endpoints.ts @@ -208,6 +208,20 @@ export interface Endpoints { "/notifications/threads/{thread_id}/subscription", "delete" >; + /** + * @see https://docs.github.com/rest/reference/codespaces#delete-an-organization-secret + */ + "DELETE /organizations/{org}/codespaces/secrets/{secret_name}": Operation< + "/organizations/{org}/codespaces/secrets/{secret_name}", + "delete" + >; + /** + * @see https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret + */ + "DELETE /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": Operation< + "/organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", + "delete" + >; /** * @see https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization */ @@ -905,20 +919,6 @@ export interface Endpoints { "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "delete" >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise - */ - "DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation< - "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "delete" - >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-user-from-an-enterprise - */ - "DELETE /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation< - "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "delete" - >; /** * @see https://docs.github.com/rest/reference/scim#delete-a-scim-user-from-an-organization */ @@ -1480,6 +1480,34 @@ export interface Endpoints { "/organizations/{organization_id}/custom_roles", "get" >; + /** + * @see https://docs.github.com/rest/reference/codespaces#list-organization-secrets + */ + "GET /organizations/{org}/codespaces/secrets": Operation< + "/organizations/{org}/codespaces/secrets", + "get" + >; + /** + * @see https://docs.github.com/rest/reference/codespaces#get-an-organization-public-key + */ + "GET /organizations/{org}/codespaces/secrets/public-key": Operation< + "/organizations/{org}/codespaces/secrets/public-key", + "get" + >; + /** + * @see https://docs.github.com/rest/reference/codespaces#get-an-organization-secret + */ + "GET /organizations/{org}/codespaces/secrets/{secret_name}": Operation< + "/organizations/{org}/codespaces/secrets/{secret_name}", + "get" + >; + /** + * @see https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret + */ + "GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories": Operation< + "/organizations/{org}/codespaces/secrets/{secret_name}/repositories", + "get" + >; /** * @see https://docs.github.com/rest/reference/codespaces#list-in-organization * @deprecated "org_id" is now "org" @@ -2741,6 +2769,20 @@ export interface Endpoints { "/repos/{owner}/{repo}/contributors", "get" >; + /** + * @see https://docs.github.com/rest/reference/dependabot#list-dependabot-alerts-for-a-repository + */ + "GET /repos/{owner}/{repo}/dependabot/alerts": Operation< + "/repos/{owner}/{repo}/dependabot/alerts", + "get" + >; + /** + * @see https://docs.github.com/rest/reference/dependabot#get-a-dependabot-alert + */ + "GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number}": Operation< + "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", + "get" + >; /** * @see https://docs.github.com/rest/reference/dependabot#list-repository-secrets */ @@ -3487,34 +3529,6 @@ export interface Endpoints { "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "get" >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise - */ - "GET /scim/v2/enterprises/{enterprise}/Groups": Operation< - "/scim/v2/enterprises/{enterprise}/Groups", - "get" - >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group - */ - "GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation< - "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "get" - >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise - */ - "GET /scim/v2/enterprises/{enterprise}/Users": Operation< - "/scim/v2/enterprises/{enterprise}/Users", - "get" - >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-user - */ - "GET /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation< - "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "get" - >; /** * @see https://docs.github.com/rest/reference/scim#list-scim-provisioned-identities */ @@ -4253,6 +4267,13 @@ export interface Endpoints { "/repos/{owner}/{repo}/comments/{comment_id}", "patch" >; + /** + * @see https://docs.github.com/rest/reference/dependabot#update-a-dependabot-alert + */ + "PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}": Operation< + "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}", + "patch" + >; /** * @see https://docs.github.com/rest/reference/git#update-a-reference */ @@ -4365,20 +4386,6 @@ export interface Endpoints { "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "patch" >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group - */ - "PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation< - "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "patch" - >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-user - */ - "PATCH /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation< - "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "patch" - >; /** * @see https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user */ @@ -5180,20 +5187,6 @@ export interface Endpoints { "/repos/{template_owner}/{template_repo}/generate", "post" >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users - */ - "POST /scim/v2/enterprises/{enterprise}/Groups": Operation< - "/scim/v2/enterprises/{enterprise}/Groups", - "post" - >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user - */ - "POST /scim/v2/enterprises/{enterprise}/Users": Operation< - "/scim/v2/enterprises/{enterprise}/Users", - "post" - >; /** * @see https://docs.github.com/rest/reference/scim#provision-and-invite-a-scim-user */ @@ -5416,6 +5409,27 @@ export interface Endpoints { "/notifications/threads/{thread_id}/subscription", "put" >; + /** + * @see https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret + */ + "PUT /organizations/{org}/codespaces/secrets/{secret_name}": Operation< + "/organizations/{org}/codespaces/secrets/{secret_name}", + "put" + >; + /** + * @see https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret + */ + "PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories": Operation< + "/organizations/{org}/codespaces/secrets/{secret_name}/repositories", + "put" + >; + /** + * @see https://docs.github.com/rest/reference/codespaces#add-selected-repository-to-an-organization-secret + */ + "PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": Operation< + "/organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", + "put" + >; /** * @see https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization */ @@ -5857,20 +5871,6 @@ export interface Endpoints { "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "put" >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group - */ - "PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation< - "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - "put" - >; - /** - * @see https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-user - */ - "PUT /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation< - "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - "put" - >; /** * @see https://docs.github.com/rest/reference/scim#set-scim-information-for-a-provisioned-user */ From 3af70ba6c73bc4926fa8ce527e4665049d54ff0e Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Wed, 28 Sep 2022 12:34:30 +0100 Subject: [PATCH 6/6] fix(deps): switch from `@octokit/openapi-types` to `@octokit/openapi-types-ghec` This switches this package's dependency from `@octokit/openapi-types` to `@octokit/openapi-types-ghec`. This means that we still have access to and can expose types only relevant to GitHub Enterprise Server. These are now find in the `-ghec` package, whereas before they were in the basic package. --- package-lock.json | 14 +++++++------- package.json | 2 +- .../templates/endpoints.ts.template | 2 +- src/generated/Endpoints.ts | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/package-lock.json b/package-lock.json index e1639e2aa..8ed436f45 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^14.0.0" + "@octokit/openapi-types-ghec": "^14.0.0" }, "devDependencies": { "@pika/pack": "^0.3.7", @@ -1937,10 +1937,10 @@ "node": ">= 14" } }, - "node_modules/@octokit/openapi-types": { + "node_modules/@octokit/openapi-types-ghec": { "version": "14.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-14.0.0.tgz", - "integrity": "sha512-HNWisMYlR8VCnNurDU6os2ikx0s0VyEjDYHNS/h4cgb8DeOxQ0n72HyinUtdDVxJhFy3FWLGl0DJhfEWk3P5Iw==" + "resolved": "https://registry.npmjs.org/@octokit/openapi-types-ghec/-/openapi-types-ghec-14.0.0.tgz", + "integrity": "sha512-xhd9oEvn2aroGn+sk09Ptx/76Y7aKU0EIgHukHPCU1+rGJreO36baEEk6k8ZPblieHNM39FcykJQmtDrETm0KA==" }, "node_modules/@octokit/plugin-paginate-rest": { "version": "4.3.1", @@ -12415,10 +12415,10 @@ "universal-user-agent": "^6.0.0" } }, - "@octokit/openapi-types": { + "@octokit/openapi-types-ghec": { "version": "14.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-14.0.0.tgz", - "integrity": "sha512-HNWisMYlR8VCnNurDU6os2ikx0s0VyEjDYHNS/h4cgb8DeOxQ0n72HyinUtdDVxJhFy3FWLGl0DJhfEWk3P5Iw==" + "resolved": "https://registry.npmjs.org/@octokit/openapi-types-ghec/-/openapi-types-ghec-14.0.0.tgz", + "integrity": "sha512-xhd9oEvn2aroGn+sk09Ptx/76Y7aKU0EIgHukHPCU1+rGJreO36baEEk6k8ZPblieHNM39FcykJQmtDrETm0KA==" }, "@octokit/plugin-paginate-rest": { "version": "4.3.1", diff --git a/package.json b/package.json index 807c27212..19830a6b9 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ }, "description": "Shared TypeScript definitions for Octokit projects", "dependencies": { - "@octokit/openapi-types": "^14.0.0" + "@octokit/openapi-types-ghec": "^14.0.0" }, "scripts": { "build": "pika-pack build", diff --git a/scripts/update-endpoints/templates/endpoints.ts.template b/scripts/update-endpoints/templates/endpoints.ts.template index b15aedd66..f14cc1b33 100644 --- a/scripts/update-endpoints/templates/endpoints.ts.template +++ b/scripts/update-endpoints/templates/endpoints.ts.template @@ -1,5 +1,5 @@ // DO NOT EDIT THIS FILE -import { paths } from "@octokit/openapi-types"; +import { paths } from "@octokit/openapi-types-ghec"; import { OctokitResponse } from "../OctokitResponse"; import { RequestHeaders } from "../RequestHeaders"; import { RequestRequestOptions } from "../RequestRequestOptions"; diff --git a/src/generated/Endpoints.ts b/src/generated/Endpoints.ts index db196f5ae..52984d62b 100644 --- a/src/generated/Endpoints.ts +++ b/src/generated/Endpoints.ts @@ -1,5 +1,5 @@ // DO NOT EDIT THIS FILE -import { paths } from "@octokit/openapi-types"; +import { paths } from "@octokit/openapi-types-ghec"; import { OctokitResponse } from "../OctokitResponse"; import { RequestHeaders } from "../RequestHeaders"; import { RequestRequestOptions } from "../RequestRequestOptions";