From d197c7ba9725a4e5be50d93655ce2ce6e9a6e0b5 Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Tue, 19 Mar 2024 12:06:44 +0000 Subject: [PATCH 1/3] WIP: schema updates --- cache/api.github.com.json | 83 ++++++++++++++++++- cache/ghec.json | 83 ++++++++++++++++++- cache/ghes-3.10.json | 14 ++++ cache/ghes-3.11.json | 14 ++++ cache/ghes-3.12.json | 14 ++++ cache/ghes-3.8.json | 14 ++++ cache/ghes-3.9.json | 14 ++++ .../openapi-webhooks-types-ghec/types.d.ts | 27 +++++- packages/openapi-webhooks-types/types.d.ts | 27 +++++- .../generated/api.github.com.json | 69 ++++++++++++++- packages/openapi-webhooks/generated/ghec.json | 69 ++++++++++++++- 11 files changed, 416 insertions(+), 12 deletions(-) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 0d6df45..1aade8e 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -38147,6 +38147,68 @@ "commit_url" ] }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": ["/example/Home.md"] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": ["af5626b4a114abcb82d63db7c8082c3c4756e51b"] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": ["302c0b7e200761c9dd9b57e57db540ee0b4293a5"] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, "secret-scanning-location-issue-title": { "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", @@ -38319,6 +38381,7 @@ "type": "string", "enum": [ "commit", + "wiki_commit", "issue_title", "issue_body", "issue_comment", @@ -38339,6 +38402,9 @@ { "$ref": "#/components/schemas/secret-scanning-location-commit" }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, { "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, @@ -38374,8 +38440,7 @@ } ] } - }, - "required": ["type", "details"] + } }, "repository-advisory-create": { "type": "object", @@ -156784,6 +156849,20 @@ "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" } }, + { + "type": "wiki_commit", + "details": { + "path": "/example/Home.md", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, { "type": "issue_title", "details": { diff --git a/cache/ghec.json b/cache/ghec.json index 9f3ece2..4141847 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -39194,6 +39194,68 @@ "commit_url" ] }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": ["/example/Home.md"] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": ["af5626b4a114abcb82d63db7c8082c3c4756e51b"] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": ["302c0b7e200761c9dd9b57e57db540ee0b4293a5"] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, "secret-scanning-location-issue-title": { "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", @@ -39366,6 +39428,7 @@ "type": "string", "enum": [ "commit", + "wiki_commit", "issue_title", "issue_body", "issue_comment", @@ -39386,6 +39449,9 @@ { "$ref": "#/components/schemas/secret-scanning-location-commit" }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, { "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, @@ -39421,8 +39487,7 @@ } ] } - }, - "required": ["type", "details"] + } }, "repository-advisory-create": { "type": "object", @@ -159398,6 +159463,20 @@ "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" } }, + { + "type": "wiki_commit", + "details": { + "path": "/example/Home.md", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, { "type": "issue_title", "details": { diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json index db71bbb..bc9cab1 100644 --- a/cache/ghes-3.10.json +++ b/cache/ghes-3.10.json @@ -149066,6 +149066,20 @@ "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" } }, + { + "type": "wiki_commit", + "details": { + "path": "/example/Home.md", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, { "type": "issue_title", "details": { diff --git a/cache/ghes-3.11.json b/cache/ghes-3.11.json index 2e762e5..c4985f3 100644 --- a/cache/ghes-3.11.json +++ b/cache/ghes-3.11.json @@ -151136,6 +151136,20 @@ "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" } }, + { + "type": "wiki_commit", + "details": { + "path": "/example/Home.md", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, { "type": "issue_title", "details": { diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json index 0b23de5..86e65a8 100644 --- a/cache/ghes-3.12.json +++ b/cache/ghes-3.12.json @@ -152304,6 +152304,20 @@ "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" } }, + { + "type": "wiki_commit", + "details": { + "path": "/example/Home.md", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, { "type": "issue_title", "details": { diff --git a/cache/ghes-3.8.json b/cache/ghes-3.8.json index 7e3b8c5..a92a4c5 100644 --- a/cache/ghes-3.8.json +++ b/cache/ghes-3.8.json @@ -145864,6 +145864,20 @@ "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" } }, + { + "type": "wiki_commit", + "details": { + "path": "/example/Home.md", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, { "type": "issue_title", "details": { diff --git a/cache/ghes-3.9.json b/cache/ghes-3.9.json index 0a83ec6..b31c53c 100644 --- a/cache/ghes-3.9.json +++ b/cache/ghes-3.9.json @@ -147723,6 +147723,20 @@ "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" } }, + { + "type": "wiki_commit", + "details": { + "path": "/example/Home.md", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, { "type": "issue_title", "details": { diff --git a/packages/openapi-webhooks-types-ghec/types.d.ts b/packages/openapi-webhooks-types-ghec/types.d.ts index 4339335..29a82b1 100644 --- a/packages/openapi-webhooks-types-ghec/types.d.ts +++ b/packages/openapi-webhooks-types-ghec/types.d.ts @@ -61692,8 +61692,9 @@ export interface components { * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. * @enum {string} */ - type: + type?: | "commit" + | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" @@ -61705,8 +61706,9 @@ export interface components { | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; - details: + details?: | components["schemas"]["secret-scanning-location-commit"] + | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] @@ -61740,6 +61742,27 @@ export interface components { /** @description The API URL to get the associated commit resource */ commit_url: string; }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** @description The file path of the wiki page */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** @description SHA-1 hash ID of the associated blob */ + blob_sha: string; + /** @description The GitHub URL to get the associated wiki page */ + page_url: string; + /** @description SHA-1 hash ID of the associated commit */ + commit_sha: string; + /** @description The GitHub URL to get the associated wiki commit */ + commit_url: string; + }; /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** diff --git a/packages/openapi-webhooks-types/types.d.ts b/packages/openapi-webhooks-types/types.d.ts index bce8cab..b3264fb 100644 --- a/packages/openapi-webhooks-types/types.d.ts +++ b/packages/openapi-webhooks-types/types.d.ts @@ -61471,8 +61471,9 @@ export interface components { * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. * @enum {string} */ - type: + type?: | "commit" + | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" @@ -61484,8 +61485,9 @@ export interface components { | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; - details: + details?: | components["schemas"]["secret-scanning-location-commit"] + | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] @@ -61519,6 +61521,27 @@ export interface components { /** @description The API URL to get the associated commit resource */ commit_url: string; }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** @description The file path of the wiki page */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** @description SHA-1 hash ID of the associated blob */ + blob_sha: string; + /** @description The GitHub URL to get the associated wiki page */ + page_url: string; + /** @description SHA-1 hash ID of the associated commit */ + commit_sha: string; + /** @description The GitHub URL to get the associated wiki commit */ + commit_url: string; + }; /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** diff --git a/packages/openapi-webhooks/generated/api.github.com.json b/packages/openapi-webhooks/generated/api.github.com.json index a795c13..464397a 100644 --- a/packages/openapi-webhooks/generated/api.github.com.json +++ b/packages/openapi-webhooks/generated/api.github.com.json @@ -111647,6 +111647,7 @@ "type": "string", "enum": [ "commit", + "wiki_commit", "issue_title", "issue_body", "issue_comment", @@ -111667,6 +111668,9 @@ { "$ref": "#/components/schemas/secret-scanning-location-commit" }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, { "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, @@ -111702,8 +111706,7 @@ } ] } - }, - "required": ["type", "details"] + } }, "secret-scanning-location-commit": { "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", @@ -111761,6 +111764,68 @@ "commit_url" ] }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": ["/example/Home.md"] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": ["af5626b4a114abcb82d63db7c8082c3c4756e51b"] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": ["302c0b7e200761c9dd9b57e57db540ee0b4293a5"] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, "secret-scanning-location-issue-title": { "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", diff --git a/packages/openapi-webhooks/generated/ghec.json b/packages/openapi-webhooks/generated/ghec.json index d089b47..bc5807d 100644 --- a/packages/openapi-webhooks/generated/ghec.json +++ b/packages/openapi-webhooks/generated/ghec.json @@ -111915,6 +111915,7 @@ "type": "string", "enum": [ "commit", + "wiki_commit", "issue_title", "issue_body", "issue_comment", @@ -111935,6 +111936,9 @@ { "$ref": "#/components/schemas/secret-scanning-location-commit" }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, { "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, @@ -111970,8 +111974,7 @@ } ] } - }, - "required": ["type", "details"] + } }, "secret-scanning-location-commit": { "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", @@ -112029,6 +112032,68 @@ "commit_url" ] }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": ["/example/Home.md"] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": ["af5626b4a114abcb82d63db7c8082c3c4756e51b"] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": ["302c0b7e200761c9dd9b57e57db540ee0b4293a5"] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, "secret-scanning-location-issue-title": { "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", From f34e7ec8f314970ba57fd9e76f1872fead385474 Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Wed, 20 Mar 2024 12:06:06 +0000 Subject: [PATCH 2/3] WIP: schema updates --- cache/api.github.com.json | 30 +++++++++------- cache/ghec.json | 36 ++++++++++++------- cache/ghes-3.10.json | 11 +++--- cache/ghes-3.11.json | 30 +++++++++------- cache/ghes-3.12.json | 30 +++++++++------- cache/ghes-3.8.json | 11 +++--- cache/ghes-3.9.json | 11 +++--- .../openapi-webhooks-types-ghec/types.d.ts | 11 +++--- .../types.d.ts | 11 +++--- .../types.d.ts | 11 +++--- .../types.d.ts | 11 +++--- .../types.d.ts | 11 +++--- .../types.d.ts | 11 +++--- packages/openapi-webhooks-types/types.d.ts | 11 +++--- .../generated/api.github.com.json | 11 +++--- packages/openapi-webhooks/generated/ghec.json | 11 +++--- .../openapi-webhooks/generated/ghes-3.10.json | 11 +++--- .../openapi-webhooks/generated/ghes-3.11.json | 11 +++--- .../openapi-webhooks/generated/ghes-3.12.json | 11 +++--- .../openapi-webhooks/generated/ghes-3.8.json | 11 +++--- .../openapi-webhooks/generated/ghes-3.9.json | 11 +++--- 21 files changed, 179 insertions(+), 134 deletions(-) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 1aade8e..9d56604 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -14836,8 +14836,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -27182,17 +27181,17 @@ } } }, - "repository-rule-params-thresholds": { - "title": "Thresholds", - "description": "This setting will not take effect unless at least one code scanning status check is enabled.", + "repository-rule-params-code-scanning-threshold": { + "title": "CodeScanningThreshold", + "description": "A tool and its thresholds.", "type": "object", "properties": { - "code_scanning_alert_threshold": { + "alerts": { "type": "string", "description": "Code scanning alert threshold", "enum": ["none", "errors", "errors_and_warnings", "all"] }, - "code_scanning_security_alert_threshold": { + "security_alerts": { "type": "string", "description": "Code scanning security alert threshold.", "enum": [ @@ -27202,12 +27201,13 @@ "medium_or_higher", "all" ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" } }, - "required": [ - "code_scanning_alert_threshold", - "code_scanning_security_alert_threshold" - ] + "required": ["alerts", "security_alerts", "tool"] }, "repository-rule": { "title": "Repository Rule", @@ -126612,11 +126612,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/cache/ghec.json b/cache/ghec.json index 4141847..2b79f30 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -14842,8 +14842,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" @@ -22426,6 +22425,11 @@ "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise.", "examples": [false] }, + "advanced_security_enabled_for_new_user_namespace_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories.", + "examples": [false] + }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this\nenterprise.", @@ -28305,17 +28309,17 @@ } } }, - "repository-rule-params-thresholds": { - "title": "Thresholds", - "description": "This setting will not take effect unless at least one code scanning status check is enabled.", + "repository-rule-params-code-scanning-threshold": { + "title": "CodeScanningThreshold", + "description": "A tool and its thresholds.", "type": "object", "properties": { - "code_scanning_alert_threshold": { + "alerts": { "type": "string", "description": "Code scanning alert threshold", "enum": ["none", "errors", "errors_and_warnings", "all"] }, - "code_scanning_security_alert_threshold": { + "security_alerts": { "type": "string", "description": "Code scanning security alert threshold.", "enum": [ @@ -28325,12 +28329,13 @@ "medium_or_higher", "all" ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" } }, - "required": [ - "code_scanning_alert_threshold", - "code_scanning_security_alert_threshold" - ] + "required": ["alerts", "security_alerts", "tool"] }, "repository-rule": { "title": "Repository Rule", @@ -128357,11 +128362,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { @@ -166138,6 +166147,7 @@ "type": "string", "enum": [ "advanced_security", + "advanced_security_user_namespace", "dependabot_alerts", "secret_scanning", "secret_scanning_push_protection" diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json index bc9cab1..8b6eb93 100644 --- a/cache/ghes-3.10.json +++ b/cache/ghes-3.10.json @@ -15743,8 +15743,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -120473,11 +120472,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/cache/ghes-3.11.json b/cache/ghes-3.11.json index c4985f3..92dd119 100644 --- a/cache/ghes-3.11.json +++ b/cache/ghes-3.11.json @@ -15893,8 +15893,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -28474,17 +28473,17 @@ } } }, - "repository-rule-params-thresholds": { - "title": "Thresholds", - "description": "This setting will not take effect unless at least one code scanning status check is enabled.", + "repository-rule-params-code-scanning-threshold": { + "title": "CodeScanningThreshold", + "description": "A tool and its thresholds.", "type": "object", "properties": { - "code_scanning_alert_threshold": { + "alerts": { "type": "string", "description": "Code scanning alert threshold", "enum": ["none", "errors", "errors_and_warnings", "all"] }, - "code_scanning_security_alert_threshold": { + "security_alerts": { "type": "string", "description": "Code scanning security alert threshold.", "enum": [ @@ -28494,12 +28493,13 @@ "medium_or_higher", "all" ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" } }, - "required": [ - "code_scanning_alert_threshold", - "code_scanning_security_alert_threshold" - ] + "required": ["alerts", "security_alerts", "tool"] }, "repository-rule": { "title": "Repository Rule", @@ -122026,11 +122026,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json index 86e65a8..dcc73c2 100644 --- a/cache/ghes-3.12.json +++ b/cache/ghes-3.12.json @@ -16067,8 +16067,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.12/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -29124,17 +29123,17 @@ } } }, - "repository-rule-params-thresholds": { - "title": "Thresholds", - "description": "This setting will not take effect unless at least one code scanning status check is enabled.", + "repository-rule-params-code-scanning-threshold": { + "title": "CodeScanningThreshold", + "description": "A tool and its thresholds.", "type": "object", "properties": { - "code_scanning_alert_threshold": { + "alerts": { "type": "string", "description": "Code scanning alert threshold", "enum": ["none", "errors", "errors_and_warnings", "all"] }, - "code_scanning_security_alert_threshold": { + "security_alerts": { "type": "string", "description": "Code scanning security alert threshold.", "enum": [ @@ -29144,12 +29143,13 @@ "medium_or_higher", "all" ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" } }, - "required": [ - "code_scanning_alert_threshold", - "code_scanning_security_alert_threshold" - ] + "required": ["alerts", "security_alerts", "tool"] }, "repository-rule": { "title": "Repository Rule", @@ -122883,11 +122883,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/cache/ghes-3.8.json b/cache/ghes-3.8.json index a92a4c5..feecc6a 100644 --- a/cache/ghes-3.8.json +++ b/cache/ghes-3.8.json @@ -14742,8 +14742,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.8/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -117951,11 +117950,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/cache/ghes-3.9.json b/cache/ghes-3.9.json index b31c53c..ed53b6d 100644 --- a/cache/ghes-3.9.json +++ b/cache/ghes-3.9.json @@ -15360,8 +15360,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -119432,11 +119431,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/packages/openapi-webhooks-types-ghec/types.d.ts b/packages/openapi-webhooks-types-ghec/types.d.ts index 29a82b1..0e1ef76 100644 --- a/packages/openapi-webhooks-types-ghec/types.d.ts +++ b/packages/openapi-webhooks-types-ghec/types.d.ts @@ -2175,10 +2175,9 @@ export interface webhooks { }; "repository-dispatch-sample.collected": { /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ post: operations["repository-dispatch/sample.collected"]; }; @@ -60586,9 +60585,10 @@ export interface components { }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { - /** @enum {string} */ - action: "sample.collected"; + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + action: string; branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ client_payload: { [key: string]: unknown; } | null; @@ -75049,10 +75049,9 @@ export interface operations { }; }; /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ "repository-dispatch/sample.collected": { parameters: { diff --git a/packages/openapi-webhooks-types-ghes-3.10/types.d.ts b/packages/openapi-webhooks-types-ghes-3.10/types.d.ts index ea26467..c87bf70 100644 --- a/packages/openapi-webhooks-types-ghes-3.10/types.d.ts +++ b/packages/openapi-webhooks-types-ghes-3.10/types.d.ts @@ -2000,10 +2000,9 @@ export interface webhooks { }; "repository-dispatch-sample.collected": { /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ post: operations["repository-dispatch/sample.collected"]; }; @@ -56877,9 +56876,10 @@ export interface components { }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { - /** @enum {string} */ - action: "sample.collected"; + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + action: string; branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ client_payload: { [key: string]: unknown; } | null; @@ -70953,10 +70953,9 @@ export interface operations { }; }; /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ "repository-dispatch/sample.collected": { parameters: { diff --git a/packages/openapi-webhooks-types-ghes-3.11/types.d.ts b/packages/openapi-webhooks-types-ghes-3.11/types.d.ts index ceda42a..9569c20 100644 --- a/packages/openapi-webhooks-types-ghes-3.11/types.d.ts +++ b/packages/openapi-webhooks-types-ghes-3.11/types.d.ts @@ -2022,10 +2022,9 @@ export interface webhooks { }; "repository-dispatch-sample.collected": { /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ post: operations["repository-dispatch/sample.collected"]; }; @@ -56953,9 +56952,10 @@ export interface components { }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { - /** @enum {string} */ - action: "sample.collected"; + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + action: string; branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ client_payload: { [key: string]: unknown; } | null; @@ -71571,10 +71571,9 @@ export interface operations { }; }; /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ "repository-dispatch/sample.collected": { parameters: { diff --git a/packages/openapi-webhooks-types-ghes-3.12/types.d.ts b/packages/openapi-webhooks-types-ghes-3.12/types.d.ts index ff5356e..e1524d5 100644 --- a/packages/openapi-webhooks-types-ghes-3.12/types.d.ts +++ b/packages/openapi-webhooks-types-ghes-3.12/types.d.ts @@ -2048,10 +2048,9 @@ export interface webhooks { }; "repository-dispatch-sample.collected": { /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ post: operations["repository-dispatch/sample.collected"]; }; @@ -57011,9 +57010,10 @@ export interface components { }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { - /** @enum {string} */ - action: "sample.collected"; + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + action: string; branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ client_payload: { [key: string]: unknown; } | null; @@ -71723,10 +71723,9 @@ export interface operations { }; }; /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ "repository-dispatch/sample.collected": { parameters: { diff --git a/packages/openapi-webhooks-types-ghes-3.8/types.d.ts b/packages/openapi-webhooks-types-ghes-3.8/types.d.ts index b016991..5098306 100644 --- a/packages/openapi-webhooks-types-ghes-3.8/types.d.ts +++ b/packages/openapi-webhooks-types-ghes-3.8/types.d.ts @@ -1856,10 +1856,9 @@ export interface webhooks { }; "repository-dispatch-sample.collected": { /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ post: operations["repository-dispatch/sample.collected"]; }; @@ -56391,9 +56390,10 @@ export interface components { }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { - /** @enum {string} */ - action: "sample.collected"; + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + action: string; branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ client_payload: { [key: string]: unknown; } | null; @@ -69923,10 +69923,9 @@ export interface operations { }; }; /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ "repository-dispatch/sample.collected": { parameters: { diff --git a/packages/openapi-webhooks-types-ghes-3.9/types.d.ts b/packages/openapi-webhooks-types-ghes-3.9/types.d.ts index c0e2f5f..d163eed 100644 --- a/packages/openapi-webhooks-types-ghes-3.9/types.d.ts +++ b/packages/openapi-webhooks-types-ghes-3.9/types.d.ts @@ -1947,10 +1947,9 @@ export interface webhooks { }; "repository-dispatch-sample.collected": { /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ post: operations["repository-dispatch/sample.collected"]; }; @@ -56615,9 +56614,10 @@ export interface components { }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { - /** @enum {string} */ - action: "sample.collected"; + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + action: string; branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ client_payload: { [key: string]: unknown; } | null; @@ -70448,10 +70448,9 @@ export interface operations { }; }; /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ "repository-dispatch/sample.collected": { parameters: { diff --git a/packages/openapi-webhooks-types/types.d.ts b/packages/openapi-webhooks-types/types.d.ts index b3264fb..6d96e2c 100644 --- a/packages/openapi-webhooks-types/types.d.ts +++ b/packages/openapi-webhooks-types/types.d.ts @@ -2175,10 +2175,9 @@ export interface webhooks { }; "repository-dispatch-sample.collected": { /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ post: operations["repository-dispatch/sample.collected"]; }; @@ -60381,9 +60380,10 @@ export interface components { }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { - /** @enum {string} */ - action: "sample.collected"; + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + action: string; branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ client_payload: { [key: string]: unknown; } | null; @@ -74796,10 +74796,9 @@ export interface operations { }; }; /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). + * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ "repository-dispatch/sample.collected": { parameters: { diff --git a/packages/openapi-webhooks/generated/api.github.com.json b/packages/openapi-webhooks/generated/api.github.com.json index 464397a..0f7d352 100644 --- a/packages/openapi-webhooks/generated/api.github.com.json +++ b/packages/openapi-webhooks/generated/api.github.com.json @@ -16153,8 +16153,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -109793,11 +109792,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "installation": { "$ref": "#/components/schemas/simple-installation" diff --git a/packages/openapi-webhooks/generated/ghec.json b/packages/openapi-webhooks/generated/ghec.json index bc5807d..ca3a2bb 100644 --- a/packages/openapi-webhooks/generated/ghec.json +++ b/packages/openapi-webhooks/generated/ghec.json @@ -16159,8 +16159,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" @@ -110045,11 +110044,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/packages/openapi-webhooks/generated/ghes-3.10.json b/packages/openapi-webhooks/generated/ghes-3.10.json index 2945f89..f5aeb0a 100644 --- a/packages/openapi-webhooks/generated/ghes-3.10.json +++ b/packages/openapi-webhooks/generated/ghes-3.10.json @@ -17298,8 +17298,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -105725,11 +105724,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/packages/openapi-webhooks/generated/ghes-3.11.json b/packages/openapi-webhooks/generated/ghes-3.11.json index 542491c..2ca584c 100644 --- a/packages/openapi-webhooks/generated/ghes-3.11.json +++ b/packages/openapi-webhooks/generated/ghes-3.11.json @@ -17462,8 +17462,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -106170,11 +106169,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/packages/openapi-webhooks/generated/ghes-3.12.json b/packages/openapi-webhooks/generated/ghes-3.12.json index 7bad7cb..efc832e 100644 --- a/packages/openapi-webhooks/generated/ghes-3.12.json +++ b/packages/openapi-webhooks/generated/ghes-3.12.json @@ -17654,8 +17654,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.12/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -106408,11 +106407,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/packages/openapi-webhooks/generated/ghes-3.8.json b/packages/openapi-webhooks/generated/ghes-3.8.json index f6d7a73..e85c4fe 100644 --- a/packages/openapi-webhooks/generated/ghes-3.8.json +++ b/packages/openapi-webhooks/generated/ghes-3.8.json @@ -16197,8 +16197,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.8/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -103961,11 +103960,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { diff --git a/packages/openapi-webhooks/generated/ghes-3.9.json b/packages/openapi-webhooks/generated/ghes-3.9.json index b90677d..6c791f2 100644 --- a/packages/openapi-webhooks/generated/ghes-3.9.json +++ b/packages/openapi-webhooks/generated/ghes-3.9.json @@ -16878,8 +16878,7 @@ }, "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_dispatch" @@ -104896,11 +104895,15 @@ "title": "repository_dispatch event", "type": "object", "properties": { - "action": { "type": "string", "enum": ["sample.collected"] }, + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], - "additionalProperties": true + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { From 69c1877eab47e4334c035df6d2438f828fbc581a Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Tue, 26 Mar 2024 12:06:52 +0000 Subject: [PATCH 3/3] WIP: schema updates --- cache/api.github.com.json | 8 ++++++++ cache/ghec.json | 8 ++++++++ cache/ghes-3.10.json | 8 ++++++++ cache/ghes-3.11.json | 8 ++++++++ cache/ghes-3.12.json | 8 ++++++++ cache/ghes-3.8.json | 8 ++++++++ cache/ghes-3.9.json | 8 ++++++++ 7 files changed, 56 insertions(+) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 9d56604..eb5dbe9 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -164514,6 +164514,14 @@ "schema": { "$ref": "#/components/schemas/basic-error" } } } + }, + "unacceptable": { + "description": "Unacceptable", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } } }, "headers": { diff --git a/cache/ghec.json b/cache/ghec.json index 2b79f30..c7477bb 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -167337,6 +167337,14 @@ } } }, + "unacceptable": { + "description": "Unacceptable", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, "scim_bad_request": { "description": "Bad request", "content": { diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json index 8b6eb93..6782fcc 100644 --- a/cache/ghes-3.10.json +++ b/cache/ghes-3.10.json @@ -155616,6 +155616,14 @@ } } }, + "unacceptable": { + "description": "Unacceptable", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, "scim_bad_request": { "description": "Bad request", "content": { diff --git a/cache/ghes-3.11.json b/cache/ghes-3.11.json index 92dd119..79d946e 100644 --- a/cache/ghes-3.11.json +++ b/cache/ghes-3.11.json @@ -157694,6 +157694,14 @@ } } }, + "unacceptable": { + "description": "Unacceptable", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, "scim_bad_request": { "description": "Bad request", "content": { diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json index dcc73c2..3a77caa 100644 --- a/cache/ghes-3.12.json +++ b/cache/ghes-3.12.json @@ -158916,6 +158916,14 @@ } } }, + "unacceptable": { + "description": "Unacceptable", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, "scim_bad_request": { "description": "Bad request", "content": { diff --git a/cache/ghes-3.8.json b/cache/ghes-3.8.json index feecc6a..8e53f26 100644 --- a/cache/ghes-3.8.json +++ b/cache/ghes-3.8.json @@ -151991,6 +151991,14 @@ } } }, + "unacceptable": { + "description": "Unacceptable", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, "no_content": { "description": "A header with no content is returned." }, "scim_bad_request": { "description": "Bad request", diff --git a/cache/ghes-3.9.json b/cache/ghes-3.9.json index ed53b6d..6f01371 100644 --- a/cache/ghes-3.9.json +++ b/cache/ghes-3.9.json @@ -154187,6 +154187,14 @@ } } }, + "unacceptable": { + "description": "Unacceptable", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, "no_content": { "description": "A header with no content is returned." }, "scim_bad_request": { "description": "Bad request",