From 79f4aba1dd99d92401f279874b8811450c561d58 Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Thu, 18 Aug 2022 08:21:03 -0700 Subject: [PATCH] feat: add support for new `permissions.organization_custom_roles` request body and response attributes across many APIs (plus description tweaks) (#225) WIP --- cache/api.github.com.json | 54 ++++++++++--------- cache/ghes-3.2.json | 10 +++- cache/ghes-3.3.json | 10 +++- cache/ghes-3.4.json | 10 +++- cache/ghes-3.5.json | 10 +++- cache/ghes-3.6.json | 10 +++- cache/github.ae.json | 10 +++- packages/openapi-types-ghes-3.2/package.json | 2 +- packages/openapi-types-ghes-3.2/types.d.ts | 5 ++ packages/openapi-types-ghes-3.3/package.json | 2 +- packages/openapi-types-ghes-3.3/types.d.ts | 5 ++ packages/openapi-types-ghes-3.4/package.json | 2 +- packages/openapi-types-ghes-3.4/types.d.ts | 5 ++ packages/openapi-types-ghes-3.5/package.json | 2 +- packages/openapi-types-ghes-3.5/types.d.ts | 5 ++ packages/openapi-types-ghes-3.6/package.json | 2 +- packages/openapi-types-ghes-3.6/types.d.ts | 5 ++ packages/openapi-types-github.ae/package.json | 2 +- packages/openapi-types-github.ae/types.d.ts | 5 ++ packages/openapi-types/package.json | 2 +- packages/openapi-types/types.d.ts | 28 +++++----- 21 files changed, 134 insertions(+), 52 deletions(-) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 06f2be697..73c466c4b 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.2.0", + "version": "7.3.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": { @@ -59823,6 +59823,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -76340,8 +76348,6 @@ } }, "dependency": { - "title": "Dependency", - "description": "A single package dependency.", "type": "object", "properties": { "package_url": { @@ -76383,8 +76389,6 @@ "additionalProperties": false }, "manifest": { - "title": "manifest", - "description": "A collection of related dependencies declared in a file or representing a logical group of dependencies.", "type": "object", "properties": { "name": { @@ -76407,6 +76411,8 @@ "$ref": "#/components/schemas/metadata" }, "resolved": { + "type": "object", + "description": "A collection of resolved package dependencies.", "additionalProperties": { "$ref": "#/components/schemas/dependency" } @@ -76495,7 +76501,7 @@ }, "manifests": { "type": "object", - "description": "A collection of package manifests", + "description": "A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.", "additionalProperties": { "$ref": "#/components/schemas/manifest" } @@ -85858,7 +85864,7 @@ "node_id" ] }, - "merge-group-checks-requested": { + "webhook-merge-group-checks-requested": { "type": "object", "properties": { "action": { @@ -85867,33 +85873,33 @@ "installation": { "$ref": "#/components/schemas/simple-installation" }, - "organization": { - "$ref": "#/components/schemas/organization-simple" - }, - "repository": { - "$ref": "#/components/schemas/repository" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - }, "merge_group": { "type": "object", - "required": [ - "head_sha", - "head_ref", - "base_ref" - ], "properties": { - "head_sha": { + "base_ref": { "type": "string" }, "head_ref": { "type": "string" }, - "base_ref": { + "head_sha": { "type": "string" } - } + }, + "required": [ + "head_sha", + "head_ref", + "base_ref" + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple" + }, + "repository": { + "$ref": "#/components/schemas/repository" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" } }, "required": [ diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json index d014fb392..2ffe0b759 100644 --- a/cache/ghes-3.2.json +++ b/cache/ghes-3.2.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.2.0", + "version": "7.3.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": { @@ -51313,6 +51313,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.json index a083ed6d6..2944ab937 100644 --- a/cache/ghes-3.3.json +++ b/cache/ghes-3.3.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.2.0", + "version": "7.3.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": { @@ -51378,6 +51378,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/cache/ghes-3.4.json b/cache/ghes-3.4.json index fad5fc7d5..3b340ac07 100644 --- a/cache/ghes-3.4.json +++ b/cache/ghes-3.4.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.2.0", + "version": "7.3.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": { @@ -53167,6 +53167,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/cache/ghes-3.5.json b/cache/ghes-3.5.json index 89c6ffbce..a514f927a 100644 --- a/cache/ghes-3.5.json +++ b/cache/ghes-3.5.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.2.0", + "version": "7.3.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": { @@ -54324,6 +54324,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/cache/ghes-3.6.json b/cache/ghes-3.6.json index 5740bb726..0eead28f6 100644 --- a/cache/ghes-3.6.json +++ b/cache/ghes-3.6.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.2.0", + "version": "7.3.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": { @@ -58356,6 +58356,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/cache/github.ae.json b/cache/github.ae.json index b2a3a239d..6d4aadb1b 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.2.0", + "version": "7.3.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": { @@ -51961,6 +51961,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/packages/openapi-types-ghes-3.2/package.json b/packages/openapi-types-ghes-3.2/package.json index 8df05b71c..8c126d88d 100644 --- a/packages/openapi-types-ghes-3.2/package.json +++ b/packages/openapi-types-ghes-3.2/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.2.0" + "openapi-version": "7.3.0" } } diff --git a/packages/openapi-types-ghes-3.2/types.d.ts b/packages/openapi-types-ghes-3.2/types.d.ts index 7226e5379..c73074b48 100644 --- a/packages/openapi-types-ghes-3.2/types.d.ts +++ b/packages/openapi-types-ghes-3.2/types.d.ts @@ -5208,6 +5208,11 @@ export interface components { * @enum {string} */ contents?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom roles management. + * @enum {string} + */ + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} diff --git a/packages/openapi-types-ghes-3.3/package.json b/packages/openapi-types-ghes-3.3/package.json index d34466321..982039c34 100644 --- a/packages/openapi-types-ghes-3.3/package.json +++ b/packages/openapi-types-ghes-3.3/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.2.0" + "openapi-version": "7.3.0" } } diff --git a/packages/openapi-types-ghes-3.3/types.d.ts b/packages/openapi-types-ghes-3.3/types.d.ts index 60817c456..a839134ad 100644 --- a/packages/openapi-types-ghes-3.3/types.d.ts +++ b/packages/openapi-types-ghes-3.3/types.d.ts @@ -5354,6 +5354,11 @@ export interface components { * @enum {string} */ contents?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom roles management. + * @enum {string} + */ + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} diff --git a/packages/openapi-types-ghes-3.4/package.json b/packages/openapi-types-ghes-3.4/package.json index 692fc6c58..b1a4d4533 100644 --- a/packages/openapi-types-ghes-3.4/package.json +++ b/packages/openapi-types-ghes-3.4/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.2.0" + "openapi-version": "7.3.0" } } diff --git a/packages/openapi-types-ghes-3.4/types.d.ts b/packages/openapi-types-ghes-3.4/types.d.ts index f2c8543cf..0bc1193c1 100644 --- a/packages/openapi-types-ghes-3.4/types.d.ts +++ b/packages/openapi-types-ghes-3.4/types.d.ts @@ -5665,6 +5665,11 @@ export interface components { * @enum {string} */ contents?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom roles management. + * @enum {string} + */ + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} diff --git a/packages/openapi-types-ghes-3.5/package.json b/packages/openapi-types-ghes-3.5/package.json index 43273c699..50dac5bca 100644 --- a/packages/openapi-types-ghes-3.5/package.json +++ b/packages/openapi-types-ghes-3.5/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.2.0" + "openapi-version": "7.3.0" } } diff --git a/packages/openapi-types-ghes-3.5/types.d.ts b/packages/openapi-types-ghes-3.5/types.d.ts index a380ca842..ffd745b91 100644 --- a/packages/openapi-types-ghes-3.5/types.d.ts +++ b/packages/openapi-types-ghes-3.5/types.d.ts @@ -5769,6 +5769,11 @@ export interface components { * @enum {string} */ contents?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom roles management. + * @enum {string} + */ + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} diff --git a/packages/openapi-types-ghes-3.6/package.json b/packages/openapi-types-ghes-3.6/package.json index 1ac6baf0a..cb620e243 100644 --- a/packages/openapi-types-ghes-3.6/package.json +++ b/packages/openapi-types-ghes-3.6/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.2.0" + "openapi-version": "7.3.0" } } diff --git a/packages/openapi-types-ghes-3.6/types.d.ts b/packages/openapi-types-ghes-3.6/types.d.ts index fae831580..c5521814d 100644 --- a/packages/openapi-types-ghes-3.6/types.d.ts +++ b/packages/openapi-types-ghes-3.6/types.d.ts @@ -6390,6 +6390,11 @@ export interface components { * @enum {string} */ contents?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom roles management. + * @enum {string} + */ + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index aac3e7826..072c5bc2b 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.2.0" + "openapi-version": "7.3.0" } } diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index c541c8b46..36569f9ab 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -5492,6 +5492,11 @@ export interface components { * @enum {string} */ contents?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom roles management. + * @enum {string} + */ + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index 7788e67b2..1e5ec094f 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.2.0" + "openapi-version": "7.3.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index 459b03436..704217840 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -7064,6 +7064,11 @@ export interface components { * @enum {string} */ contents?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom roles management. + * @enum {string} + */ + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} @@ -15411,10 +15416,6 @@ export interface components { metadata: { [key: string]: Partial & Partial & Partial; }; - /** - * Dependency - * @description A single package dependency. - */ dependency: { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. @@ -15440,10 +15441,6 @@ export interface components { */ dependencies?: string[]; }; - /** - * manifest - * @description A collection of related dependencies declared in a file or representing a logical group of dependencies. - */ manifest: { /** * @description The name of the manifest. @@ -15458,6 +15455,7 @@ export interface components { source_location?: string; }; metadata?: components["schemas"]["metadata"]; + /** @description A collection of resolved package dependencies. */ resolved?: { [key: string]: components["schemas"]["dependency"] }; }; /** @@ -15513,7 +15511,7 @@ export interface components { url: string; }; metadata?: components["schemas"]["metadata"]; - /** @description A collection of package manifests */ + /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ manifests?: { [key: string]: components["schemas"]["manifest"] }; /** * Format: date-time @@ -19498,17 +19496,17 @@ export interface components { */ node_id: string; }; - "merge-group-checks-requested": { + "webhook-merge-group-checks-requested": { action: string; installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple"]; - repository?: components["schemas"]["repository"]; - sender?: components["schemas"]["simple-user"]; merge_group: { - head_sha: string; - head_ref: string; base_ref: string; + head_ref: string; + head_sha: string; }; + organization?: components["schemas"]["organization-simple"]; + repository?: components["schemas"]["repository"]; + sender?: components["schemas"]["simple-user"]; }; }; responses: {