diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index b7f3887231..f58dde440d 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -621422,6 +621422,10969 @@ } } }, + "bypass-request-secret-scanning-cancelled": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass request was cancelled.", + "operationId": "exemption-request-secret-scanning/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-completed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning bypass request was completed.", + "operationId": "exemption-request-secret-scanning/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass request was created.", + "operationId": "exemption-request-secret-scanning/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-response-dismissed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass response was dismissed.", + "operationId": "exemption-request-secret-scanning/response-dismissed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption response dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_dismissed" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-response-submitted": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", + "operationId": "exemption-request-secret-scanning/response-submitted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption response submitted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_submitted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "check-run-completed": { "post": { "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index d75da99769..e568749200 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -52122,7 +52122,7 @@ paths: check. type: array items: *341 - deployment: &627 + deployment: &629 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -67557,7 +67557,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &658 + last_response: &660 title: Hook Response type: object properties: @@ -83647,7 +83647,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &676 + items: &678 type: object properties: type: @@ -103443,6 +103443,605 @@ webhooks: - repository - organization - app + bypass-request-secret-scanning-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was cancelled. + operationId: exemption-request-secret-scanning/cancelled + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption request cancellation event + type: object + properties: + action: + type: string + enum: + - cancelled + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: &627 + title: Exemption Request + description: A request from a user to be exempted from a set of + rules. + type: object + properties: + id: + type: integer + description: The ID of the exemption request. + number: + type: integer + description: The number uniquely identifying the exemption request + within it's repository. + repository_id: + type: integer + description: The ID of the repository the exemption request + is for. + requester_id: + type: integer + description: The ID of the user who requested the exemption. + requester_login: + type: string + description: The login of the user who requested the exemption. + request_type: + type: string + description: The type of request. + enum: + - push_ruleset_bypass + - secret_scanning + exemption_request_data: + oneOf: + - title: Push ruleset bypass exemption request data + description: Push rules that are being requested to be bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - push_ruleset_bypass + data: + type: array + description: The data pertaining to the push rules that + are being requested to be bypassed. + items: + type: object + properties: + ruleset_id: + type: integer + description: The ID of the ruleset for the rules + that were violated + ruleset_name: + type: string + description: The name of the ruleset for the rules + that were violated + total_violations: + type: integer + description: The number of violations + rule_type: + type: string + description: The type of rule that was violated + - title: Secret scanning push protection exemption request data + description: Secret scanning push protections that are being + requested to be bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - secret_scanning + data: + type: array + description: The data pertaining to the secret scanning + push protections that are being requested to be bypassed. + items: + type: object + properties: + secret_type: + type: string + description: The type of secret that was detected + commits: + type: array + description: The commits that introduced the secret + items: + type: string + resource_identifier: + type: string + description: The unique identifier for the request type of the + exemption request. For example, a commit SHA. + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + status: + type: string + description: The status of the exemption request. + enum: + - pending + - rejected + - cancelled + - completed + requester_comment: + type: + - string + - 'null' + description: The comment the requester provided when creating + the exemption request. + metadata: + type: + - object + - 'null' + description: Metadata about the exemption request. + oneOf: + - title: Secret Scanning Push Protection Exemption Request Metadata + description: Metadata for a secret scanning push protection + exemption request. + type: object + properties: + label: + type: string + description: The label for the secret type + reason: + type: string + description: The reason for the exemption request + enum: + - fixed_later + - false_positive + - tests + expires_at: + type: string + format: date-time + description: The date and time the exemption request will expire. + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + responses: + type: + - array + - 'null' + description: The responses to the exemption request. + items: &628 + title: Exemption response + description: A response to an exemption request by a delegated + bypasser. + type: object + properties: + id: + type: integer + description: The ID of the exemption response. + reviewer_id: + type: integer + description: The ID of the user who reviewed the exemption + request. + reviewer_login: + type: string + description: The login of the user who reviewed the exemption + request. + status: + type: string + description: The status of the exemption response. + enum: + - approved + - rejected + - dismissed + created_at: + type: string + format: date-time + description: The date and time the exemption request was + created. + html_url: + type: string + description: The URL to view the exemption request in a browser. + format: uri + examples: + - https://github.com/monalisa/smile/exemptions/1 + sender: *625 + required: + - action + - exemption_request + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning bypass request was completed. + operationId: exemption-request-secret-scanning/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption request completed event + type: object + properties: + action: + type: string + enum: + - completed + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: *627 + sender: *625 + required: + - action + - exemption_request + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was created. + operationId: exemption-request-secret-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption request created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: *627 + sender: *625 + required: + - action + - exemption_request + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass response was dismissed. + operationId: exemption-request-secret-scanning/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption response dismissed event + type: object + properties: + action: + type: string + enum: + - response_dismissed + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: *627 + exemption_response: *628 + sender: *625 + required: + - action + - exemption_request + - exemption_response + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A response either approving or rejecting the secret scanning push + protection bypass request was submitted. + operationId: exemption-request-secret-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption response submitted event + type: object + properties: + action: + type: string + enum: + - response_submitted + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: *627 + exemption_response: *628 + sender: *625 + required: + - action + - exemption_request + - exemption_response + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app check-run-completed: post: summary: |- @@ -103507,7 +104106,7 @@ webhooks: type: string enum: - completed - check_run: &628 + check_run: &630 title: CheckRun description: A check performed on the code of a given code change type: object @@ -103620,7 +104219,7 @@ webhooks: - examples: - neutral - deployment: *627 + deployment: *629 details_url: type: string examples: @@ -104112,7 +104711,7 @@ webhooks: type: string enum: - created - check_run: *628 + check_run: *630 installation: *622 organization: *623 repository: *624 @@ -104510,7 +105109,7 @@ webhooks: type: string enum: - requested_action - check_run: *628 + check_run: *630 installation: *622 organization: *623 repository: *624 @@ -104917,7 +105516,7 @@ webhooks: type: string enum: - rerequested - check_run: *628 + check_run: *630 installation: *622 organization: *623 repository: *624 @@ -107566,7 +108165,7 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &629 + commit_oid: &631 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. @@ -107574,7 +108173,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - ref: &630 + ref: &632 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. @@ -107905,11 +108504,11 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *629 + commit_oid: *631 enterprise: *621 installation: *622 organization: *623 - ref: *630 + ref: *632 repository: *624 sender: *625 required: @@ -108180,11 +108779,11 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *629 + commit_oid: *631 enterprise: *621 installation: *622 organization: *623 - ref: *630 + ref: *632 repository: *624 sender: *625 required: @@ -108515,11 +109114,11 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *629 + commit_oid: *631 enterprise: *621 installation: *622 organization: *623 - ref: *630 + ref: *632 repository: *624 sender: *625 required: @@ -109031,11 +109630,11 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *629 + commit_oid: *631 enterprise: *621 installation: *622 organization: *623 - ref: *630 + ref: *632 repository: *624 sender: *625 required: @@ -109386,11 +109985,11 @@ webhooks: `main`). type: string organization: *623 - pusher_type: &631 + pusher_type: &633 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &632 + ref: &634 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -109819,8 +110418,8 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - pusher_type: *631 - ref: *632 + pusher_type: *633 + ref: *634 ref_type: description: The type of Git ref object deleted in the repository. type: string @@ -110508,7 +111107,7 @@ webhooks: - created enterprise: *621 installation: *622 - key: &633 + key: &635 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -110624,7 +111223,7 @@ webhooks: - deleted enterprise: *621 installation: *622 - key: *633 + key: *635 organization: *623 repository: *624 sender: *625 @@ -111199,7 +111798,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: &637 + workflow: &639 title: Workflow type: - object @@ -112010,7 +112609,7 @@ webhooks: type: string enum: - approved - approver: &634 + approver: &636 type: object properties: avatar_url: @@ -112055,7 +112654,7 @@ webhooks: installation: *622 organization: *623 repository: *624 - reviewers: &635 + reviewers: &637 type: array items: type: object @@ -112136,7 +112735,7 @@ webhooks: sender: *625 since: type: string - workflow_job_run: &636 + workflow_job_run: &638 type: object properties: conclusion: @@ -112874,18 +113473,18 @@ webhooks: type: string enum: - rejected - approver: *634 + approver: *636 comment: type: string enterprise: *621 installation: *622 organization: *623 repository: *624 - reviewers: *635 + reviewers: *637 sender: *625 since: type: string - workflow_job_run: *636 + workflow_job_run: *638 workflow_job_runs: type: array items: @@ -113600,7 +114199,7 @@ webhooks: installation: *622 organization: *623 repository: *624 - requestor: &642 + requestor: &644 title: User type: - object @@ -115524,7 +116123,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: *637 + workflow: *639 workflow_run: title: Deployment Workflow Run type: @@ -116210,7 +116809,7 @@ webhooks: type: string enum: - answered - answer: &640 + answer: &642 type: object properties: author_association: @@ -116367,7 +116966,7 @@ webhooks: - created_at - updated_at - body - discussion: &638 + discussion: &640 title: Discussion description: A Discussion in a repository. type: object @@ -116806,7 +117405,7 @@ webhooks: - from required: - category - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -116892,7 +117491,7 @@ webhooks: type: string enum: - closed - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -116977,7 +117576,7 @@ webhooks: type: string enum: - created - comment: &639 + comment: &641 type: object properties: author_association: @@ -117134,7 +117733,7 @@ webhooks: - updated_at - body - reactions - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117220,8 +117819,8 @@ webhooks: type: string enum: - deleted - comment: *639 - discussion: *638 + comment: *641 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117319,8 +117918,8 @@ webhooks: - from required: - body - comment: *639 - discussion: *638 + comment: *641 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117407,7 +118006,7 @@ webhooks: type: string enum: - created - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117492,7 +118091,7 @@ webhooks: type: string enum: - deleted - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117595,7 +118194,7 @@ webhooks: type: string required: - from - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117680,10 +118279,10 @@ webhooks: type: string enum: - labeled - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 - label: &641 + label: &643 title: Label type: object properties: @@ -117799,7 +118398,7 @@ webhooks: type: string enum: - locked - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117884,7 +118483,7 @@ webhooks: type: string enum: - pinned - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117969,7 +118568,7 @@ webhooks: type: string enum: - reopened - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -118057,12 +118656,12 @@ webhooks: changes: type: object properties: - new_discussion: *638 + new_discussion: *640 new_repository: *624 required: - new_discussion - new_repository - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -118148,8 +118747,8 @@ webhooks: type: string enum: - unanswered - discussion: *638 - old_answer: *640 + discussion: *640 + old_answer: *642 organization: *623 repository: *624 sender: *625 @@ -118232,10 +118831,10 @@ webhooks: type: string enum: - unlabeled - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -118319,7 +118918,7 @@ webhooks: type: string enum: - unlocked - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -118404,7 +119003,7 @@ webhooks: type: string enum: - unpinned - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -119423,7 +120022,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: &643 + repositories: &645 description: An array of repository objects that the installation can access. type: array @@ -119450,7 +120049,7 @@ webhooks: - full_name - private repository: *624 - requester: *642 + requester: *644 sender: *625 required: - action @@ -119528,7 +120127,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: *643 + repositories: *645 repository: *624 requester: type: @@ -119609,7 +120208,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: *643 + repositories: *645 repository: *624 requester: type: @@ -119690,7 +120289,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories_added: &644 + repositories_added: &646 description: An array of repository objects, which were added to the installation. type: array @@ -119737,14 +120336,14 @@ webhooks: description: Whether the repository is private or public. type: boolean repository: *624 - repository_selection: &645 + repository_selection: &647 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *642 + requester: *644 sender: *625 required: - action @@ -119826,7 +120425,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories_added: *644 + repositories_added: *646 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -119854,8 +120453,8 @@ webhooks: - full_name - private repository: *624 - repository_selection: *645 - requester: *642 + repository_selection: *647 + requester: *644 sender: *625 required: - action @@ -119937,7 +120536,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: *643 + repositories: *645 repository: *624 requester: type: @@ -120204,7 +120803,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: *643 + repositories: *645 repository: *624 requester: type: @@ -121694,7 +122293,7 @@ webhooks: type: string enum: - deleted - comment: &646 + comment: &648 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -123098,7 +123697,7 @@ webhooks: type: string enum: - edited - changes: &668 + changes: &670 description: The changes to the comment. type: object properties: @@ -123110,7 +123709,7 @@ webhooks: type: string required: - from - comment: *646 + comment: *648 enterprise: *621 installation: *622 issue: @@ -124356,10 +124955,10 @@ webhooks: type: string enum: - assigned - assignee: *642 + assignee: *644 enterprise: *621 installation: *622 - issue: &649 + issue: &651 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -128420,7 +129019,7 @@ webhooks: url: type: string format: uri - milestone: &647 + milestone: &649 title: Milestone description: A collection of related issues and pull requests. type: object @@ -129583,7 +130182,7 @@ webhooks: - active_lock_reason - body - reactions - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -130586,7 +131185,7 @@ webhooks: - active_lock_reason - body - reactions - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -132588,7 +133187,7 @@ webhooks: url: type: string format: uri - milestone: *647 + milestone: *649 organization: *623 repository: *624 sender: *625 @@ -135064,7 +135663,7 @@ webhooks: - pinned enterprise: *621 installation: *622 - issue: &648 + issue: &650 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -138455,7 +139054,7 @@ webhooks: - new_repository enterprise: *621 installation: *622 - issue: *648 + issue: *650 organization: *623 repository: *624 sender: *625 @@ -138538,7 +139137,7 @@ webhooks: type: string enum: - unassigned - assignee: &671 + assignee: &673 title: User type: - object @@ -138610,7 +139209,7 @@ webhooks: - id enterprise: *621 installation: *622 - issue: *649 + issue: *651 organization: *623 repository: *624 sender: *625 @@ -138693,8 +139292,8 @@ webhooks: - unlabeled enterprise: *621 installation: *622 - issue: *649 - label: *641 + issue: *651 + label: *643 organization: *623 repository: *624 sender: *625 @@ -139778,7 +140377,7 @@ webhooks: - unpinned enterprise: *621 installation: *622 - issue: *648 + issue: *650 organization: *623 repository: *624 sender: *625 @@ -139861,7 +140460,7 @@ webhooks: - created enterprise: *621 installation: *622 - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -139943,7 +140542,7 @@ webhooks: - deleted enterprise: *621 installation: *622 - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -140057,7 +140656,7 @@ webhooks: - from enterprise: *621 installation: *622 - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -140143,7 +140742,7 @@ webhooks: type: string enterprise: *621 installation: *622 - marketplace_purchase: &650 + marketplace_purchase: &652 title: Marketplace Purchase type: object required: @@ -140232,7 +140831,7 @@ webhooks: unit_count: type: integer organization: *623 - previous_marketplace_purchase: &651 + previous_marketplace_purchase: &653 title: Marketplace Purchase type: object properties: @@ -140398,7 +140997,7 @@ webhooks: type: string enterprise: *621 installation: *622 - marketplace_purchase: *650 + marketplace_purchase: *652 organization: *623 previous_marketplace_purchase: title: Marketplace Purchase @@ -140571,7 +141170,7 @@ webhooks: type: string enterprise: *621 installation: *622 - marketplace_purchase: *650 + marketplace_purchase: *652 organization: *623 previous_marketplace_purchase: title: Marketplace Purchase @@ -140827,7 +141426,7 @@ webhooks: unit_count: type: integer organization: *623 - previous_marketplace_purchase: *651 + previous_marketplace_purchase: *653 repository: *624 sender: *625 required: @@ -140910,9 +141509,9 @@ webhooks: type: string enterprise: *621 installation: *622 - marketplace_purchase: *650 + marketplace_purchase: *652 organization: *623 - previous_marketplace_purchase: *651 + previous_marketplace_purchase: *653 repository: *624 sender: *625 required: @@ -141017,7 +141616,7 @@ webhooks: - to enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 sender: *625 @@ -141123,7 +141722,7 @@ webhooks: - 'null' enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 sender: *625 @@ -141206,7 +141805,7 @@ webhooks: - removed enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 sender: *625 @@ -141288,7 +141887,7 @@ webhooks: - added enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 scope: @@ -141366,7 +141965,7 @@ webhooks: required: - login - id - team: &652 + team: &654 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -141561,7 +142160,7 @@ webhooks: - removed enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 scope: @@ -141640,7 +142239,7 @@ webhooks: required: - login - id - team: *652 + team: *654 required: - action - scope @@ -141723,7 +142322,7 @@ webhooks: enum: - checks_requested installation: *622 - merge_group: &653 + merge_group: &655 type: object title: Merge Group description: 'A group of pull requests that the merge queue has @@ -141839,7 +142438,7 @@ webhooks: - invalidated - dequeued installation: *622 - merge_group: *653 + merge_group: *655 organization: *623 repository: *624 sender: *625 @@ -142109,7 +142708,7 @@ webhooks: - closed enterprise: *621 installation: *622 - milestone: *647 + milestone: *649 organization: *623 repository: *624 sender: *625 @@ -142192,7 +142791,7 @@ webhooks: - created enterprise: *621 installation: *622 - milestone: &654 + milestone: &656 title: Milestone description: A collection of related issues and pull requests. type: object @@ -142414,7 +143013,7 @@ webhooks: - deleted enterprise: *621 installation: *622 - milestone: *647 + milestone: *649 organization: *623 repository: *624 sender: *625 @@ -142528,7 +143127,7 @@ webhooks: - from enterprise: *621 installation: *622 - milestone: *647 + milestone: *649 organization: *623 repository: *624 sender: *625 @@ -142612,7 +143211,7 @@ webhooks: - opened enterprise: *621 installation: *622 - milestone: *654 + milestone: *656 organization: *623 repository: *624 sender: *625 @@ -142693,7 +143292,7 @@ webhooks: type: string enum: - blocked - blocked_user: *642 + blocked_user: *644 enterprise: *621 installation: *622 organization: *623 @@ -142776,7 +143375,7 @@ webhooks: type: string enum: - unblocked - blocked_user: *642 + blocked_user: *644 enterprise: *621 installation: *622 organization: *623 @@ -142861,7 +143460,7 @@ webhooks: - deleted enterprise: *621 installation: *622 - membership: &655 + membership: &657 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -143033,7 +143632,7 @@ webhooks: - member_added enterprise: *621 installation: *622 - membership: *655 + membership: *657 organization: *623 repository: *624 sender: *625 @@ -143238,7 +143837,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - user: *642 + user: *644 required: - action - invitation @@ -143318,7 +143917,7 @@ webhooks: - member_removed enterprise: *621 installation: *622 - membership: *655 + membership: *657 organization: *623 repository: *624 sender: *625 @@ -143409,7 +144008,7 @@ webhooks: type: string enterprise: *621 installation: *622 - membership: *655 + membership: *657 organization: *623 repository: *624 sender: *625 @@ -144006,7 +144605,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &656 + items: &658 title: Ruby Gems metadata type: object properties: @@ -144537,7 +145136,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *656 + items: *658 source_url: type: string format: uri @@ -144871,7 +145470,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &657 + personal_access_token_request: &659 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -145090,7 +145689,7 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *657 + personal_access_token_request: *659 enterprise: *621 organization: *623 sender: *625 @@ -145171,7 +145770,7 @@ webhooks: type: string enum: - created - personal_access_token_request: *657 + personal_access_token_request: *659 enterprise: *621 organization: *623 sender: *625 @@ -145251,7 +145850,7 @@ webhooks: type: string enum: - denied - personal_access_token_request: *657 + personal_access_token_request: *659 organization: *623 enterprise: *621 sender: *625 @@ -145359,7 +145958,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *658 + last_response: *660 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -145640,7 +146239,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_card: &659 + project_card: &661 title: Project Card type: object properties: @@ -145845,7 +146444,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_card: *659 + project_card: *661 repository: *624 sender: *625 required: @@ -146153,7 +146752,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_card: *659 + project_card: *661 repository: *624 sender: *625 required: @@ -146528,7 +147127,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: &661 + project: &663 title: Project type: object properties: @@ -146736,7 +147335,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_column: &660 + project_column: &662 title: Project Column type: object properties: @@ -146858,7 +147457,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_column: *660 + project_column: *662 repository: anyOf: - type: 'null' @@ -146954,7 +147553,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_column: *660 + project_column: *662 repository: *624 sender: *625 required: @@ -147038,7 +147637,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_column: *660 + project_column: *662 repository: *624 sender: *625 required: @@ -147122,7 +147721,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: *661 + project: *663 repository: *624 sender: *625 required: @@ -147206,7 +147805,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: *661 + project: *663 repository: anyOf: - type: 'null' @@ -147314,7 +147913,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: *661 + project: *663 repository: *624 sender: *625 required: @@ -147397,7 +147996,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: *661 + project: *663 repository: *624 sender: *625 required: @@ -147480,7 +148079,7 @@ webhooks: - closed installation: *622 organization: *623 - projects_v2: &662 + projects_v2: &664 title: Projects v2 Project description: A projects v2 project type: object @@ -147629,7 +148228,7 @@ webhooks: - created installation: *622 organization: *623 - projects_v2: *662 + projects_v2: *664 sender: *625 required: - action @@ -147711,7 +148310,7 @@ webhooks: - deleted installation: *622 organization: *623 - projects_v2: *662 + projects_v2: *664 sender: *625 required: - action @@ -147833,7 +148432,7 @@ webhooks: type: string installation: *622 organization: *623 - projects_v2: *662 + projects_v2: *664 sender: *625 required: - action @@ -147915,7 +148514,7 @@ webhooks: type: string enum: - archived - changes: &664 + changes: &666 type: object properties: archived_at: @@ -147933,7 +148532,7 @@ webhooks: format: date-time installation: *622 organization: *623 - projects_v2_item: &663 + projects_v2_item: &665 title: Projects v2 Item description: An item belonging to a project type: object @@ -148073,7 +148672,7 @@ webhooks: type: string installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148156,7 +148755,7 @@ webhooks: - created installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148238,7 +148837,7 @@ webhooks: - deleted installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148350,7 +148949,7 @@ webhooks: - body installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148448,7 +149047,7 @@ webhooks: - 'null' installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148530,10 +149129,10 @@ webhooks: type: string enum: - restored - changes: *664 + changes: *666 installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148616,7 +149215,7 @@ webhooks: - reopened installation: *622 organization: *623 - projects_v2: *662 + projects_v2: *664 sender: *625 required: - action @@ -148767,10 +149366,10 @@ webhooks: type: string enum: - assigned - assignee: *642 + assignee: *644 enterprise: *621 installation: *622 - number: &665 + number: &667 description: The pull request number. type: integer organization: *623 @@ -155986,9 +156585,9 @@ webhooks: - closed enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: &666 + pull_request: &668 allOf: - *487 - type: object @@ -156135,9 +156734,9 @@ webhooks: - converted_to_draft enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -156220,9 +156819,9 @@ webhooks: - demilestoned enterprise: *621 milestone: *387 - number: *665 + number: *667 organization: *623 - pull_request: &667 + pull_request: &669 title: Pull Request type: object properties: @@ -161043,9 +161642,9 @@ webhooks: - from enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -163518,8 +164117,8 @@ webhooks: - labeled enterprise: *621 installation: *622 - label: *641 - number: *665 + label: *643 + number: *667 organization: *623 pull_request: title: Pull Request @@ -165926,7 +166525,7 @@ webhooks: - locked enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 pull_request: title: Pull Request @@ -168330,9 +168929,9 @@ webhooks: - milestoned enterprise: *621 milestone: *387 - number: *665 + number: *667 organization: *623 - pull_request: *667 + pull_request: *669 repository: *624 sender: *625 required: @@ -168414,9 +169013,9 @@ webhooks: - opened enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -168500,9 +169099,9 @@ webhooks: - ready_for_review enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -168585,9 +169184,9 @@ webhooks: - reopened enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -171249,7 +171848,7 @@ webhooks: type: string enum: - deleted - comment: &669 + comment: &671 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -173816,8 +174415,8 @@ webhooks: type: string enum: - edited - changes: *668 - comment: *669 + changes: *670 + comment: *671 enterprise: *621 installation: *622 organization: *623 @@ -180646,7 +181245,7 @@ webhooks: - auto_merge - active_lock_reason repository: *624 - review: &670 + review: &672 description: The review that was affected. type: object properties: @@ -192942,7 +193541,7 @@ webhooks: - auto_merge - active_lock_reason repository: *624 - review: *670 + review: *672 sender: *625 required: - action @@ -198007,7 +198606,7 @@ webhooks: type: string enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 pull_request: title: Pull Request @@ -200400,10 +200999,10 @@ webhooks: type: string enum: - unassigned - assignee: *671 + assignee: *673 enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 pull_request: title: Pull Request @@ -202810,8 +203409,8 @@ webhooks: - unlabeled enterprise: *621 installation: *622 - label: *641 - number: *665 + label: *643 + number: *667 organization: *623 pull_request: title: Pull Request @@ -205209,7 +205808,7 @@ webhooks: - unlocked enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 pull_request: title: Pull Request @@ -208869,7 +209468,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *656 + items: *658 summary: type: string tag_name: @@ -209310,7 +209909,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *656 + items: *658 summary: type: string tag_name: @@ -209440,7 +210039,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: &672 + release: &674 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -209834,7 +210433,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: *672 + release: *674 repository: *624 sender: *625 required: @@ -209946,7 +210545,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: *672 + release: *674 repository: *624 sender: *625 required: @@ -210425,7 +211024,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: &673 + release: &675 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -210820,7 +211419,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: *672 + release: *674 repository: *624 sender: *625 required: @@ -210900,7 +211499,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: *673 + release: *675 repository: *624 sender: *625 required: @@ -212556,7 +213155,7 @@ webhooks: type: string enum: - create - alert: &674 + alert: &676 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -212970,7 +213569,7 @@ webhooks: type: string enum: - reopen - alert: *674 + alert: *676 enterprise: *621 installation: *622 organization: *623 @@ -213256,7 +213855,7 @@ webhooks: type: string enum: - created - alert: &675 + alert: &677 type: object properties: number: *69 @@ -213412,9 +214011,9 @@ webhooks: type: string enum: - created - alert: *675 + alert: *677 installation: *622 - location: *676 + location: *678 organization: *623 repository: *624 sender: *625 @@ -213652,7 +214251,7 @@ webhooks: type: string enum: - reopened - alert: *675 + alert: *677 enterprise: *621 installation: *622 organization: *623 @@ -213734,7 +214333,7 @@ webhooks: type: string enum: - resolved - alert: *675 + alert: *677 enterprise: *621 installation: *622 organization: *623 @@ -213816,7 +214415,7 @@ webhooks: type: string enum: - validated - alert: *675 + alert: *677 enterprise: *621 installation: *622 organization: *623 @@ -213900,7 +214499,7 @@ webhooks: installation: *622 organization: *623 repository: *624 - security_advisory: &677 + security_advisory: &679 description: The details of the security advisory, including summary, description, and severity. type: object @@ -214089,7 +214688,7 @@ webhooks: installation: *622 organization: *623 repository: *624 - security_advisory: *677 + security_advisory: *679 sender: *625 required: - action @@ -214437,7 +215036,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - sponsorship: &678 + sponsorship: &680 type: object properties: created_at: @@ -214741,7 +215340,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - sponsorship @@ -214834,7 +215433,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - changes @@ -214911,7 +215510,7 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &679 + effective_date: &681 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. @@ -214921,7 +215520,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - sponsorship @@ -214995,7 +215594,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &680 + changes: &682 type: object properties: tier: @@ -215039,13 +215638,13 @@ webhooks: - from required: - tier - effective_date: *679 + effective_date: *681 enterprise: *621 installation: *622 organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - changes @@ -215122,13 +215721,13 @@ webhooks: type: string enum: - tier_changed - changes: *680 + changes: *682 enterprise: *621 installation: *622 organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - changes @@ -215837,7 +216436,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - team: &681 + team: &683 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -216499,7 +217098,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - team @@ -217044,7 +217643,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - team @@ -217590,7 +218189,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - team @@ -218203,7 +218802,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - changes @@ -218750,7 +219349,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - team @@ -220159,7 +220758,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: *637 + workflow: *639 workflow_run: title: Workflow Run type: object @@ -221174,7 +221773,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: *637 + workflow: *639 workflow_run: title: Workflow Run type: object @@ -222183,7 +222782,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: *637 + workflow: *639 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index b7f3887231..f58dde440d 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -621422,6 +621422,10969 @@ } } }, + "bypass-request-secret-scanning-cancelled": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass request was cancelled.", + "operationId": "exemption-request-secret-scanning/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-completed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning bypass request was completed.", + "operationId": "exemption-request-secret-scanning/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass request was created.", + "operationId": "exemption-request-secret-scanning/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-response-dismissed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass response was dismissed.", + "operationId": "exemption-request-secret-scanning/response-dismissed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption response dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_dismissed" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-response-submitted": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", + "operationId": "exemption-request-secret-scanning/response-submitted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption response submitted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_submitted" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, + "sender": { + "title": "Simple User", + "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "check-run-completed": { "post": { "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index d75da99769..e568749200 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -52122,7 +52122,7 @@ paths: check. type: array items: *341 - deployment: &627 + deployment: &629 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -67557,7 +67557,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &658 + last_response: &660 title: Hook Response type: object properties: @@ -83647,7 +83647,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &676 + items: &678 type: object properties: type: @@ -103443,6 +103443,605 @@ webhooks: - repository - organization - app + bypass-request-secret-scanning-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was cancelled. + operationId: exemption-request-secret-scanning/cancelled + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption request cancellation event + type: object + properties: + action: + type: string + enum: + - cancelled + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: &627 + title: Exemption Request + description: A request from a user to be exempted from a set of + rules. + type: object + properties: + id: + type: integer + description: The ID of the exemption request. + number: + type: integer + description: The number uniquely identifying the exemption request + within it's repository. + repository_id: + type: integer + description: The ID of the repository the exemption request + is for. + requester_id: + type: integer + description: The ID of the user who requested the exemption. + requester_login: + type: string + description: The login of the user who requested the exemption. + request_type: + type: string + description: The type of request. + enum: + - push_ruleset_bypass + - secret_scanning + exemption_request_data: + oneOf: + - title: Push ruleset bypass exemption request data + description: Push rules that are being requested to be bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - push_ruleset_bypass + data: + type: array + description: The data pertaining to the push rules that + are being requested to be bypassed. + items: + type: object + properties: + ruleset_id: + type: integer + description: The ID of the ruleset for the rules + that were violated + ruleset_name: + type: string + description: The name of the ruleset for the rules + that were violated + total_violations: + type: integer + description: The number of violations + rule_type: + type: string + description: The type of rule that was violated + - title: Secret scanning push protection exemption request data + description: Secret scanning push protections that are being + requested to be bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - secret_scanning + data: + type: array + description: The data pertaining to the secret scanning + push protections that are being requested to be bypassed. + items: + type: object + properties: + secret_type: + type: string + description: The type of secret that was detected + commits: + type: array + description: The commits that introduced the secret + items: + type: string + resource_identifier: + type: string + description: The unique identifier for the request type of the + exemption request. For example, a commit SHA. + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + status: + type: string + description: The status of the exemption request. + enum: + - pending + - rejected + - cancelled + - completed + requester_comment: + type: + - string + - 'null' + description: The comment the requester provided when creating + the exemption request. + metadata: + type: + - object + - 'null' + description: Metadata about the exemption request. + oneOf: + - title: Secret Scanning Push Protection Exemption Request Metadata + description: Metadata for a secret scanning push protection + exemption request. + type: object + properties: + label: + type: string + description: The label for the secret type + reason: + type: string + description: The reason for the exemption request + enum: + - fixed_later + - false_positive + - tests + expires_at: + type: string + format: date-time + description: The date and time the exemption request will expire. + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + responses: + type: + - array + - 'null' + description: The responses to the exemption request. + items: &628 + title: Exemption response + description: A response to an exemption request by a delegated + bypasser. + type: object + properties: + id: + type: integer + description: The ID of the exemption response. + reviewer_id: + type: integer + description: The ID of the user who reviewed the exemption + request. + reviewer_login: + type: string + description: The login of the user who reviewed the exemption + request. + status: + type: string + description: The status of the exemption response. + enum: + - approved + - rejected + - dismissed + created_at: + type: string + format: date-time + description: The date and time the exemption request was + created. + html_url: + type: string + description: The URL to view the exemption request in a browser. + format: uri + examples: + - https://github.com/monalisa/smile/exemptions/1 + sender: *625 + required: + - action + - exemption_request + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning bypass request was completed. + operationId: exemption-request-secret-scanning/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption request completed event + type: object + properties: + action: + type: string + enum: + - completed + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: *627 + sender: *625 + required: + - action + - exemption_request + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was created. + operationId: exemption-request-secret-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption request created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: *627 + sender: *625 + required: + - action + - exemption_request + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass response was dismissed. + operationId: exemption-request-secret-scanning/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption response dismissed event + type: object + properties: + action: + type: string + enum: + - response_dismissed + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: *627 + exemption_response: *628 + sender: *625 + required: + - action + - exemption_request + - exemption_response + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A response either approving or rejecting the secret scanning push + protection bypass request was submitted. + operationId: exemption-request-secret-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: Exemption response submitted event + type: object + properties: + action: + type: string + enum: + - response_submitted + enterprise: *621 + installation: *622 + organization: *623 + repository: *624 + exemption_request: *627 + exemption_response: *628 + sender: *625 + required: + - action + - exemption_request + - exemption_response + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app check-run-completed: post: summary: |- @@ -103507,7 +104106,7 @@ webhooks: type: string enum: - completed - check_run: &628 + check_run: &630 title: CheckRun description: A check performed on the code of a given code change type: object @@ -103620,7 +104219,7 @@ webhooks: - examples: - neutral - deployment: *627 + deployment: *629 details_url: type: string examples: @@ -104112,7 +104711,7 @@ webhooks: type: string enum: - created - check_run: *628 + check_run: *630 installation: *622 organization: *623 repository: *624 @@ -104510,7 +105109,7 @@ webhooks: type: string enum: - requested_action - check_run: *628 + check_run: *630 installation: *622 organization: *623 repository: *624 @@ -104917,7 +105516,7 @@ webhooks: type: string enum: - rerequested - check_run: *628 + check_run: *630 installation: *622 organization: *623 repository: *624 @@ -107566,7 +108165,7 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &629 + commit_oid: &631 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. @@ -107574,7 +108173,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - ref: &630 + ref: &632 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. @@ -107905,11 +108504,11 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *629 + commit_oid: *631 enterprise: *621 installation: *622 organization: *623 - ref: *630 + ref: *632 repository: *624 sender: *625 required: @@ -108180,11 +108779,11 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *629 + commit_oid: *631 enterprise: *621 installation: *622 organization: *623 - ref: *630 + ref: *632 repository: *624 sender: *625 required: @@ -108515,11 +109114,11 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *629 + commit_oid: *631 enterprise: *621 installation: *622 organization: *623 - ref: *630 + ref: *632 repository: *624 sender: *625 required: @@ -109031,11 +109630,11 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *629 + commit_oid: *631 enterprise: *621 installation: *622 organization: *623 - ref: *630 + ref: *632 repository: *624 sender: *625 required: @@ -109386,11 +109985,11 @@ webhooks: `main`). type: string organization: *623 - pusher_type: &631 + pusher_type: &633 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &632 + ref: &634 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -109819,8 +110418,8 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - pusher_type: *631 - ref: *632 + pusher_type: *633 + ref: *634 ref_type: description: The type of Git ref object deleted in the repository. type: string @@ -110508,7 +111107,7 @@ webhooks: - created enterprise: *621 installation: *622 - key: &633 + key: &635 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -110624,7 +111223,7 @@ webhooks: - deleted enterprise: *621 installation: *622 - key: *633 + key: *635 organization: *623 repository: *624 sender: *625 @@ -111199,7 +111798,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: &637 + workflow: &639 title: Workflow type: - object @@ -112010,7 +112609,7 @@ webhooks: type: string enum: - approved - approver: &634 + approver: &636 type: object properties: avatar_url: @@ -112055,7 +112654,7 @@ webhooks: installation: *622 organization: *623 repository: *624 - reviewers: &635 + reviewers: &637 type: array items: type: object @@ -112136,7 +112735,7 @@ webhooks: sender: *625 since: type: string - workflow_job_run: &636 + workflow_job_run: &638 type: object properties: conclusion: @@ -112874,18 +113473,18 @@ webhooks: type: string enum: - rejected - approver: *634 + approver: *636 comment: type: string enterprise: *621 installation: *622 organization: *623 repository: *624 - reviewers: *635 + reviewers: *637 sender: *625 since: type: string - workflow_job_run: *636 + workflow_job_run: *638 workflow_job_runs: type: array items: @@ -113600,7 +114199,7 @@ webhooks: installation: *622 organization: *623 repository: *624 - requestor: &642 + requestor: &644 title: User type: - object @@ -115524,7 +116123,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: *637 + workflow: *639 workflow_run: title: Deployment Workflow Run type: @@ -116210,7 +116809,7 @@ webhooks: type: string enum: - answered - answer: &640 + answer: &642 type: object properties: author_association: @@ -116367,7 +116966,7 @@ webhooks: - created_at - updated_at - body - discussion: &638 + discussion: &640 title: Discussion description: A Discussion in a repository. type: object @@ -116806,7 +117405,7 @@ webhooks: - from required: - category - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -116892,7 +117491,7 @@ webhooks: type: string enum: - closed - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -116977,7 +117576,7 @@ webhooks: type: string enum: - created - comment: &639 + comment: &641 type: object properties: author_association: @@ -117134,7 +117733,7 @@ webhooks: - updated_at - body - reactions - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117220,8 +117819,8 @@ webhooks: type: string enum: - deleted - comment: *639 - discussion: *638 + comment: *641 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117319,8 +117918,8 @@ webhooks: - from required: - body - comment: *639 - discussion: *638 + comment: *641 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117407,7 +118006,7 @@ webhooks: type: string enum: - created - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117492,7 +118091,7 @@ webhooks: type: string enum: - deleted - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117595,7 +118194,7 @@ webhooks: type: string required: - from - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117680,10 +118279,10 @@ webhooks: type: string enum: - labeled - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 - label: &641 + label: &643 title: Label type: object properties: @@ -117799,7 +118398,7 @@ webhooks: type: string enum: - locked - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117884,7 +118483,7 @@ webhooks: type: string enum: - pinned - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -117969,7 +118568,7 @@ webhooks: type: string enum: - reopened - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -118057,12 +118656,12 @@ webhooks: changes: type: object properties: - new_discussion: *638 + new_discussion: *640 new_repository: *624 required: - new_discussion - new_repository - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -118148,8 +118747,8 @@ webhooks: type: string enum: - unanswered - discussion: *638 - old_answer: *640 + discussion: *640 + old_answer: *642 organization: *623 repository: *624 sender: *625 @@ -118232,10 +118831,10 @@ webhooks: type: string enum: - unlabeled - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -118319,7 +118918,7 @@ webhooks: type: string enum: - unlocked - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -118404,7 +119003,7 @@ webhooks: type: string enum: - unpinned - discussion: *638 + discussion: *640 enterprise: *621 installation: *622 organization: *623 @@ -119423,7 +120022,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: &643 + repositories: &645 description: An array of repository objects that the installation can access. type: array @@ -119450,7 +120049,7 @@ webhooks: - full_name - private repository: *624 - requester: *642 + requester: *644 sender: *625 required: - action @@ -119528,7 +120127,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: *643 + repositories: *645 repository: *624 requester: type: @@ -119609,7 +120208,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: *643 + repositories: *645 repository: *624 requester: type: @@ -119690,7 +120289,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories_added: &644 + repositories_added: &646 description: An array of repository objects, which were added to the installation. type: array @@ -119737,14 +120336,14 @@ webhooks: description: Whether the repository is private or public. type: boolean repository: *624 - repository_selection: &645 + repository_selection: &647 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *642 + requester: *644 sender: *625 required: - action @@ -119826,7 +120425,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories_added: *644 + repositories_added: *646 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -119854,8 +120453,8 @@ webhooks: - full_name - private repository: *624 - repository_selection: *645 - requester: *642 + repository_selection: *647 + requester: *644 sender: *625 required: - action @@ -119937,7 +120536,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: *643 + repositories: *645 repository: *624 requester: type: @@ -120204,7 +120803,7 @@ webhooks: enterprise: *621 installation: *20 organization: *623 - repositories: *643 + repositories: *645 repository: *624 requester: type: @@ -121694,7 +122293,7 @@ webhooks: type: string enum: - deleted - comment: &646 + comment: &648 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -123098,7 +123697,7 @@ webhooks: type: string enum: - edited - changes: &668 + changes: &670 description: The changes to the comment. type: object properties: @@ -123110,7 +123709,7 @@ webhooks: type: string required: - from - comment: *646 + comment: *648 enterprise: *621 installation: *622 issue: @@ -124356,10 +124955,10 @@ webhooks: type: string enum: - assigned - assignee: *642 + assignee: *644 enterprise: *621 installation: *622 - issue: &649 + issue: &651 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -128420,7 +129019,7 @@ webhooks: url: type: string format: uri - milestone: &647 + milestone: &649 title: Milestone description: A collection of related issues and pull requests. type: object @@ -129583,7 +130182,7 @@ webhooks: - active_lock_reason - body - reactions - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -130586,7 +131185,7 @@ webhooks: - active_lock_reason - body - reactions - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -132588,7 +133187,7 @@ webhooks: url: type: string format: uri - milestone: *647 + milestone: *649 organization: *623 repository: *624 sender: *625 @@ -135064,7 +135663,7 @@ webhooks: - pinned enterprise: *621 installation: *622 - issue: &648 + issue: &650 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -138455,7 +139054,7 @@ webhooks: - new_repository enterprise: *621 installation: *622 - issue: *648 + issue: *650 organization: *623 repository: *624 sender: *625 @@ -138538,7 +139137,7 @@ webhooks: type: string enum: - unassigned - assignee: &671 + assignee: &673 title: User type: - object @@ -138610,7 +139209,7 @@ webhooks: - id enterprise: *621 installation: *622 - issue: *649 + issue: *651 organization: *623 repository: *624 sender: *625 @@ -138693,8 +139292,8 @@ webhooks: - unlabeled enterprise: *621 installation: *622 - issue: *649 - label: *641 + issue: *651 + label: *643 organization: *623 repository: *624 sender: *625 @@ -139778,7 +140377,7 @@ webhooks: - unpinned enterprise: *621 installation: *622 - issue: *648 + issue: *650 organization: *623 repository: *624 sender: *625 @@ -139861,7 +140460,7 @@ webhooks: - created enterprise: *621 installation: *622 - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -139943,7 +140542,7 @@ webhooks: - deleted enterprise: *621 installation: *622 - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -140057,7 +140656,7 @@ webhooks: - from enterprise: *621 installation: *622 - label: *641 + label: *643 organization: *623 repository: *624 sender: *625 @@ -140143,7 +140742,7 @@ webhooks: type: string enterprise: *621 installation: *622 - marketplace_purchase: &650 + marketplace_purchase: &652 title: Marketplace Purchase type: object required: @@ -140232,7 +140831,7 @@ webhooks: unit_count: type: integer organization: *623 - previous_marketplace_purchase: &651 + previous_marketplace_purchase: &653 title: Marketplace Purchase type: object properties: @@ -140398,7 +140997,7 @@ webhooks: type: string enterprise: *621 installation: *622 - marketplace_purchase: *650 + marketplace_purchase: *652 organization: *623 previous_marketplace_purchase: title: Marketplace Purchase @@ -140571,7 +141170,7 @@ webhooks: type: string enterprise: *621 installation: *622 - marketplace_purchase: *650 + marketplace_purchase: *652 organization: *623 previous_marketplace_purchase: title: Marketplace Purchase @@ -140827,7 +141426,7 @@ webhooks: unit_count: type: integer organization: *623 - previous_marketplace_purchase: *651 + previous_marketplace_purchase: *653 repository: *624 sender: *625 required: @@ -140910,9 +141509,9 @@ webhooks: type: string enterprise: *621 installation: *622 - marketplace_purchase: *650 + marketplace_purchase: *652 organization: *623 - previous_marketplace_purchase: *651 + previous_marketplace_purchase: *653 repository: *624 sender: *625 required: @@ -141017,7 +141616,7 @@ webhooks: - to enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 sender: *625 @@ -141123,7 +141722,7 @@ webhooks: - 'null' enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 sender: *625 @@ -141206,7 +141805,7 @@ webhooks: - removed enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 sender: *625 @@ -141288,7 +141887,7 @@ webhooks: - added enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 scope: @@ -141366,7 +141965,7 @@ webhooks: required: - login - id - team: &652 + team: &654 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -141561,7 +142160,7 @@ webhooks: - removed enterprise: *621 installation: *622 - member: *642 + member: *644 organization: *623 repository: *624 scope: @@ -141640,7 +142239,7 @@ webhooks: required: - login - id - team: *652 + team: *654 required: - action - scope @@ -141723,7 +142322,7 @@ webhooks: enum: - checks_requested installation: *622 - merge_group: &653 + merge_group: &655 type: object title: Merge Group description: 'A group of pull requests that the merge queue has @@ -141839,7 +142438,7 @@ webhooks: - invalidated - dequeued installation: *622 - merge_group: *653 + merge_group: *655 organization: *623 repository: *624 sender: *625 @@ -142109,7 +142708,7 @@ webhooks: - closed enterprise: *621 installation: *622 - milestone: *647 + milestone: *649 organization: *623 repository: *624 sender: *625 @@ -142192,7 +142791,7 @@ webhooks: - created enterprise: *621 installation: *622 - milestone: &654 + milestone: &656 title: Milestone description: A collection of related issues and pull requests. type: object @@ -142414,7 +143013,7 @@ webhooks: - deleted enterprise: *621 installation: *622 - milestone: *647 + milestone: *649 organization: *623 repository: *624 sender: *625 @@ -142528,7 +143127,7 @@ webhooks: - from enterprise: *621 installation: *622 - milestone: *647 + milestone: *649 organization: *623 repository: *624 sender: *625 @@ -142612,7 +143211,7 @@ webhooks: - opened enterprise: *621 installation: *622 - milestone: *654 + milestone: *656 organization: *623 repository: *624 sender: *625 @@ -142693,7 +143292,7 @@ webhooks: type: string enum: - blocked - blocked_user: *642 + blocked_user: *644 enterprise: *621 installation: *622 organization: *623 @@ -142776,7 +143375,7 @@ webhooks: type: string enum: - unblocked - blocked_user: *642 + blocked_user: *644 enterprise: *621 installation: *622 organization: *623 @@ -142861,7 +143460,7 @@ webhooks: - deleted enterprise: *621 installation: *622 - membership: &655 + membership: &657 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -143033,7 +143632,7 @@ webhooks: - member_added enterprise: *621 installation: *622 - membership: *655 + membership: *657 organization: *623 repository: *624 sender: *625 @@ -143238,7 +143837,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - user: *642 + user: *644 required: - action - invitation @@ -143318,7 +143917,7 @@ webhooks: - member_removed enterprise: *621 installation: *622 - membership: *655 + membership: *657 organization: *623 repository: *624 sender: *625 @@ -143409,7 +144008,7 @@ webhooks: type: string enterprise: *621 installation: *622 - membership: *655 + membership: *657 organization: *623 repository: *624 sender: *625 @@ -144006,7 +144605,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &656 + items: &658 title: Ruby Gems metadata type: object properties: @@ -144537,7 +145136,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *656 + items: *658 source_url: type: string format: uri @@ -144871,7 +145470,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &657 + personal_access_token_request: &659 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -145090,7 +145689,7 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *657 + personal_access_token_request: *659 enterprise: *621 organization: *623 sender: *625 @@ -145171,7 +145770,7 @@ webhooks: type: string enum: - created - personal_access_token_request: *657 + personal_access_token_request: *659 enterprise: *621 organization: *623 sender: *625 @@ -145251,7 +145850,7 @@ webhooks: type: string enum: - denied - personal_access_token_request: *657 + personal_access_token_request: *659 organization: *623 enterprise: *621 sender: *625 @@ -145359,7 +145958,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *658 + last_response: *660 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -145640,7 +146239,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_card: &659 + project_card: &661 title: Project Card type: object properties: @@ -145845,7 +146444,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_card: *659 + project_card: *661 repository: *624 sender: *625 required: @@ -146153,7 +146752,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_card: *659 + project_card: *661 repository: *624 sender: *625 required: @@ -146528,7 +147127,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: &661 + project: &663 title: Project type: object properties: @@ -146736,7 +147335,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_column: &660 + project_column: &662 title: Project Column type: object properties: @@ -146858,7 +147457,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_column: *660 + project_column: *662 repository: anyOf: - type: 'null' @@ -146954,7 +147553,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_column: *660 + project_column: *662 repository: *624 sender: *625 required: @@ -147038,7 +147637,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project_column: *660 + project_column: *662 repository: *624 sender: *625 required: @@ -147122,7 +147721,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: *661 + project: *663 repository: *624 sender: *625 required: @@ -147206,7 +147805,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: *661 + project: *663 repository: anyOf: - type: 'null' @@ -147314,7 +147913,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: *661 + project: *663 repository: *624 sender: *625 required: @@ -147397,7 +147996,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - project: *661 + project: *663 repository: *624 sender: *625 required: @@ -147480,7 +148079,7 @@ webhooks: - closed installation: *622 organization: *623 - projects_v2: &662 + projects_v2: &664 title: Projects v2 Project description: A projects v2 project type: object @@ -147629,7 +148228,7 @@ webhooks: - created installation: *622 organization: *623 - projects_v2: *662 + projects_v2: *664 sender: *625 required: - action @@ -147711,7 +148310,7 @@ webhooks: - deleted installation: *622 organization: *623 - projects_v2: *662 + projects_v2: *664 sender: *625 required: - action @@ -147833,7 +148432,7 @@ webhooks: type: string installation: *622 organization: *623 - projects_v2: *662 + projects_v2: *664 sender: *625 required: - action @@ -147915,7 +148514,7 @@ webhooks: type: string enum: - archived - changes: &664 + changes: &666 type: object properties: archived_at: @@ -147933,7 +148532,7 @@ webhooks: format: date-time installation: *622 organization: *623 - projects_v2_item: &663 + projects_v2_item: &665 title: Projects v2 Item description: An item belonging to a project type: object @@ -148073,7 +148672,7 @@ webhooks: type: string installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148156,7 +148755,7 @@ webhooks: - created installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148238,7 +148837,7 @@ webhooks: - deleted installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148350,7 +148949,7 @@ webhooks: - body installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148448,7 +149047,7 @@ webhooks: - 'null' installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148530,10 +149129,10 @@ webhooks: type: string enum: - restored - changes: *664 + changes: *666 installation: *622 organization: *623 - projects_v2_item: *663 + projects_v2_item: *665 sender: *625 required: - action @@ -148616,7 +149215,7 @@ webhooks: - reopened installation: *622 organization: *623 - projects_v2: *662 + projects_v2: *664 sender: *625 required: - action @@ -148767,10 +149366,10 @@ webhooks: type: string enum: - assigned - assignee: *642 + assignee: *644 enterprise: *621 installation: *622 - number: &665 + number: &667 description: The pull request number. type: integer organization: *623 @@ -155986,9 +156585,9 @@ webhooks: - closed enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: &666 + pull_request: &668 allOf: - *487 - type: object @@ -156135,9 +156734,9 @@ webhooks: - converted_to_draft enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -156220,9 +156819,9 @@ webhooks: - demilestoned enterprise: *621 milestone: *387 - number: *665 + number: *667 organization: *623 - pull_request: &667 + pull_request: &669 title: Pull Request type: object properties: @@ -161043,9 +161642,9 @@ webhooks: - from enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -163518,8 +164117,8 @@ webhooks: - labeled enterprise: *621 installation: *622 - label: *641 - number: *665 + label: *643 + number: *667 organization: *623 pull_request: title: Pull Request @@ -165926,7 +166525,7 @@ webhooks: - locked enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 pull_request: title: Pull Request @@ -168330,9 +168929,9 @@ webhooks: - milestoned enterprise: *621 milestone: *387 - number: *665 + number: *667 organization: *623 - pull_request: *667 + pull_request: *669 repository: *624 sender: *625 required: @@ -168414,9 +169013,9 @@ webhooks: - opened enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -168500,9 +169099,9 @@ webhooks: - ready_for_review enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -168585,9 +169184,9 @@ webhooks: - reopened enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 - pull_request: *666 + pull_request: *668 repository: *624 sender: *625 required: @@ -171249,7 +171848,7 @@ webhooks: type: string enum: - deleted - comment: &669 + comment: &671 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -173816,8 +174415,8 @@ webhooks: type: string enum: - edited - changes: *668 - comment: *669 + changes: *670 + comment: *671 enterprise: *621 installation: *622 organization: *623 @@ -180646,7 +181245,7 @@ webhooks: - auto_merge - active_lock_reason repository: *624 - review: &670 + review: &672 description: The review that was affected. type: object properties: @@ -192942,7 +193541,7 @@ webhooks: - auto_merge - active_lock_reason repository: *624 - review: *670 + review: *672 sender: *625 required: - action @@ -198007,7 +198606,7 @@ webhooks: type: string enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 pull_request: title: Pull Request @@ -200400,10 +200999,10 @@ webhooks: type: string enum: - unassigned - assignee: *671 + assignee: *673 enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 pull_request: title: Pull Request @@ -202810,8 +203409,8 @@ webhooks: - unlabeled enterprise: *621 installation: *622 - label: *641 - number: *665 + label: *643 + number: *667 organization: *623 pull_request: title: Pull Request @@ -205209,7 +205808,7 @@ webhooks: - unlocked enterprise: *621 installation: *622 - number: *665 + number: *667 organization: *623 pull_request: title: Pull Request @@ -208869,7 +209468,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *656 + items: *658 summary: type: string tag_name: @@ -209310,7 +209909,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *656 + items: *658 summary: type: string tag_name: @@ -209440,7 +210039,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: &672 + release: &674 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -209834,7 +210433,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: *672 + release: *674 repository: *624 sender: *625 required: @@ -209946,7 +210545,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: *672 + release: *674 repository: *624 sender: *625 required: @@ -210425,7 +211024,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: &673 + release: &675 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -210820,7 +211419,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: *672 + release: *674 repository: *624 sender: *625 required: @@ -210900,7 +211499,7 @@ webhooks: enterprise: *621 installation: *622 organization: *623 - release: *673 + release: *675 repository: *624 sender: *625 required: @@ -212556,7 +213155,7 @@ webhooks: type: string enum: - create - alert: &674 + alert: &676 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -212970,7 +213569,7 @@ webhooks: type: string enum: - reopen - alert: *674 + alert: *676 enterprise: *621 installation: *622 organization: *623 @@ -213256,7 +213855,7 @@ webhooks: type: string enum: - created - alert: &675 + alert: &677 type: object properties: number: *69 @@ -213412,9 +214011,9 @@ webhooks: type: string enum: - created - alert: *675 + alert: *677 installation: *622 - location: *676 + location: *678 organization: *623 repository: *624 sender: *625 @@ -213652,7 +214251,7 @@ webhooks: type: string enum: - reopened - alert: *675 + alert: *677 enterprise: *621 installation: *622 organization: *623 @@ -213734,7 +214333,7 @@ webhooks: type: string enum: - resolved - alert: *675 + alert: *677 enterprise: *621 installation: *622 organization: *623 @@ -213816,7 +214415,7 @@ webhooks: type: string enum: - validated - alert: *675 + alert: *677 enterprise: *621 installation: *622 organization: *623 @@ -213900,7 +214499,7 @@ webhooks: installation: *622 organization: *623 repository: *624 - security_advisory: &677 + security_advisory: &679 description: The details of the security advisory, including summary, description, and severity. type: object @@ -214089,7 +214688,7 @@ webhooks: installation: *622 organization: *623 repository: *624 - security_advisory: *677 + security_advisory: *679 sender: *625 required: - action @@ -214437,7 +215036,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - sponsorship: &678 + sponsorship: &680 type: object properties: created_at: @@ -214741,7 +215340,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - sponsorship @@ -214834,7 +215433,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - changes @@ -214911,7 +215510,7 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &679 + effective_date: &681 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. @@ -214921,7 +215520,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - sponsorship @@ -214995,7 +215594,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &680 + changes: &682 type: object properties: tier: @@ -215039,13 +215638,13 @@ webhooks: - from required: - tier - effective_date: *679 + effective_date: *681 enterprise: *621 installation: *622 organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - changes @@ -215122,13 +215721,13 @@ webhooks: type: string enum: - tier_changed - changes: *680 + changes: *682 enterprise: *621 installation: *622 organization: *623 repository: *624 sender: *625 - sponsorship: *678 + sponsorship: *680 required: - action - changes @@ -215837,7 +216436,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - team: &681 + team: &683 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -216499,7 +217098,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - team @@ -217044,7 +217643,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - team @@ -217590,7 +218189,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - team @@ -218203,7 +218802,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - changes @@ -218750,7 +219349,7 @@ webhooks: - topics - visibility sender: *625 - team: *681 + team: *683 required: - action - team @@ -220159,7 +220758,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: *637 + workflow: *639 workflow_run: title: Workflow Run type: object @@ -221174,7 +221773,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: *637 + workflow: *639 workflow_run: title: Workflow Run type: object @@ -222183,7 +222782,7 @@ webhooks: organization: *623 repository: *624 sender: *625 - workflow: *637 + workflow: *639 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index f0afd92b7c..d8f070efc4 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -71940,13 +71940,13 @@ } } }, - "check-run-completed": { + "bypass-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run was completed, and a conclusion is available.", - "operationId": "check-run/completed", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass request was cancelled.", + "operationId": "exemption-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72011,22 +72011,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -72038,9 +72023,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72049,13 +72033,13 @@ } } }, - "check-run-created": { + "bypass-request-secret-scanning-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A new check run was created.", - "operationId": "check-run/created", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning bypass request was completed.", + "operationId": "exemption-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72120,22 +72104,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -72147,9 +72116,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72158,13 +72126,13 @@ } } }, - "check-run-requested-action": { + "bypass-request-secret-scanning-created": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", - "operationId": "check-run/requested-action", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass request was created.", + "operationId": "exemption-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72229,22 +72197,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -72256,9 +72209,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72267,13 +72219,13 @@ } } }, - "check-run-rerequested": { + "bypass-request-secret-scanning-response-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", - "operationId": "check-run/rerequested", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass response was dismissed.", + "operationId": "exemption-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72338,22 +72290,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -72365,9 +72302,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72376,13 +72312,13 @@ } } }, - "check-suite-completed": { + "bypass-request-secret-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", + "operationId": "exemption-request-secret-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72447,7 +72383,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-completed" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -72460,7 +72396,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72469,13 +72405,13 @@ } } }, - "check-suite-requested": { + "check-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", - "operationId": "check-suite/requested", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", + "operationId": "check-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -72540,7 +72476,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-check-run-completed" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed-form-encoded" + } } } } @@ -72552,8 +72503,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -72562,13 +72514,13 @@ } } }, - "check-suite-rerequested": { + "check-run-created": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", - "operationId": "check-suite/rerequested", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A new check run was created.", + "operationId": "check-run/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -72633,7 +72585,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-check-run-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created-form-encoded" + } } } } @@ -72645,8 +72612,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -72655,13 +72623,13 @@ } } }, - "code-scanning-alert-appeared-in-branch": { + "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", - "operationId": "code-scanning-alert/appeared-in-branch", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -72726,7 +72694,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-check-run-requested-action" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + } } } } @@ -72738,8 +72721,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -72748,13 +72732,13 @@ } } }, - "code-scanning-alert-closed-by-user": { + "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -72819,7 +72803,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-check-run-rerequested" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested-form-encoded" + } } } } @@ -72831,8 +72830,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -72841,13 +72841,13 @@ } } }, - "code-scanning-alert-created": { + "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -72912,7 +72912,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-check-suite-completed" } } } @@ -72925,7 +72925,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -72934,13 +72934,13 @@ } } }, - "code-scanning-alert-fixed": { + "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -73005,7 +73005,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-check-suite-requested" } } } @@ -73018,7 +73018,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -73027,13 +73027,13 @@ } } }, - "code-scanning-alert-reopened": { + "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -73098,7 +73098,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-check-suite-rerequested" } } } @@ -73111,7 +73111,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -73120,11 +73120,11 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "code-scanning-alert-appeared-in-branch": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -73191,7 +73191,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" } } } @@ -73213,13 +73213,13 @@ } } }, - "commit-comment-created": { + "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "Someone commented on a commit.", - "operationId": "commit-comment/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73284,7 +73284,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" } } } @@ -73297,7 +73297,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "commit_comment", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -73306,12 +73306,13 @@ } } }, - "create": { + "code-scanning-alert-created": { "post": { - "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", - "operationId": "create", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73376,7 +73377,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" } } } @@ -73389,7 +73390,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "create", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -73398,197 +73399,13 @@ } } }, - "custom-property-created": { - "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A new custom property was created.", - "operationId": "custom-property/created", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-custom-property-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "custom_property", - "supported-webhook-types": [ - "organization", - "app" - ] - } - } - }, - "custom-property-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was deleted.", - "operationId": "custom-property/deleted", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-custom-property-deleted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "custom_property", - "supported-webhook-types": [ - "organization", - "app" - ] - } - } - }, - "custom-property-updated": { + "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was updated.", - "operationId": "custom-property/updated", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73653,7 +73470,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-updated" + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" } } } @@ -73666,21 +73483,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom_property", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ + "repository", "organization", "app" ] } } }, - "custom-property-values-updated": { + "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "The custom property values of a repository were updated.", - "operationId": "custom-property-values/updated", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73745,7 +73563,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" } } } @@ -73758,7 +73576,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom-property-values", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -73767,12 +73585,13 @@ } } }, - "delete": { + "code-scanning-alert-reopened-by-user": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", - "operationId": "delete", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73837,7 +73656,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" } } } @@ -73850,7 +73669,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "delete", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -73859,13 +73678,13 @@ } } }, - "dependabot-alert-auto-dismissed": { + "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", - "operationId": "dependabot-alert/auto-dismissed", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -73930,7 +73749,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-commit-comment-created" } } } @@ -73943,7 +73762,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "commit_comment", "supported-webhook-types": [ "repository", "organization", @@ -73952,13 +73771,12 @@ } } }, - "dependabot-alert-auto-reopened": { + "create": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", - "operationId": "dependabot-alert/auto-reopened", + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", + "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -74023,7 +73841,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-create" } } } @@ -74036,7 +73854,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "create", "supported-webhook-types": [ "repository", "organization", @@ -74045,13 +73863,13 @@ } } }, - "dependabot-alert-created": { + "custom-property-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A new custom property was created.", + "operationId": "custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -74116,7 +73934,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-custom-property-created" } } } @@ -74129,22 +73947,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", "organization", "app" ] } } }, - "dependabot-alert-dismissed": { + "custom-property-deleted": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was deleted.", + "operationId": "custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -74209,7 +74026,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-custom-property-deleted" } } } @@ -74222,22 +74039,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", "organization", "app" ] } } }, - "dependabot-alert-fixed": { + "custom-property-updated": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was updated.", + "operationId": "custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -74302,7 +74118,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-custom-property-updated" } } } @@ -74315,22 +74131,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", "organization", "app" ] } } }, - "dependabot-alert-reintroduced": { + "custom-property-values-updated": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "The custom property values of a repository were updated.", + "operationId": "custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" }, "parameters": [ { @@ -74395,7 +74210,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" } } } @@ -74408,7 +74223,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "custom-property-values", "supported-webhook-types": [ "repository", "organization", @@ -74417,13 +74232,12 @@ } } }, - "dependabot-alert-reopened": { + "delete": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -74488,7 +74302,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-delete" } } } @@ -74501,7 +74315,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "delete", "supported-webhook-types": [ "repository", "organization", @@ -74510,13 +74324,13 @@ } } }, - "deploy-key-created": { + "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", + "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74581,7 +74395,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" } } } @@ -74594,7 +74408,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -74603,13 +74417,13 @@ } } }, - "deploy-key-deleted": { + "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", + "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74674,7 +74488,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" } } } @@ -74687,7 +74501,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -74696,13 +74510,13 @@ } } }, - "deployment-created": { + "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74767,7 +74581,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" } } } @@ -74780,7 +74594,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -74789,13 +74603,13 @@ } } }, - "deployment-protection-rule-requested": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment protection rule was requested for an environment.", - "operationId": "deployment-protection-rule/requested", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74860,7 +74674,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" } } } @@ -74873,20 +74687,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_protection_rule", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-approved": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was approved.", - "operationId": "deployment-review/approved", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74951,7 +74767,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" } } } @@ -74964,20 +74780,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-rejected": { + "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was rejected.", - "operationId": "deployment-review/rejected", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -75042,7 +74860,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" } } } @@ -75055,20 +74873,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-requested": { + "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was requested.", - "operationId": "deployment-review/requested", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -75133,7 +74953,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" } } } @@ -75146,20 +74966,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-status-created": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -75224,7 +75046,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-deploy-key-created" } } } @@ -75237,7 +75059,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_status", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -75246,13 +75068,13 @@ } } }, - "discussion-answered": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -75317,7 +75139,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" } } } @@ -75330,7 +75152,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -75339,13 +75161,13 @@ } } }, - "discussion-category-changed": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -75410,7 +75232,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-deployment-created" } } } @@ -75423,7 +75245,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment", "supported-webhook-types": [ "repository", "organization", @@ -75432,13 +75254,13 @@ } } }, - "discussion-closed": { + "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was closed.", - "operationId": "discussion/closed", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -75460,7 +75282,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -75503,7 +75325,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" } } } @@ -75516,22 +75338,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment_protection_rule", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-comment-created": { + "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was approved.", + "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -75596,7 +75416,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-deployment-review-approved" } } } @@ -75609,22 +75429,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-comment-deleted": { + "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was rejected.", + "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -75689,7 +75507,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" } } } @@ -75702,22 +75520,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-comment-edited": { + "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was requested.", + "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -75782,7 +75598,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-deployment-review-requested" } } } @@ -75795,7 +75611,98 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "deployment_review", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "deployment-status-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-status-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_status", "supported-webhook-types": [ "repository", "organization", @@ -75804,11 +75711,11 @@ } } }, - "discussion-created": { + "discussion-answered": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -75875,7 +75782,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-answered" } } } @@ -75897,11 +75804,11 @@ } } }, - "discussion-deleted": { + "discussion-category-changed": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -75968,7 +75875,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-category-changed" } } } @@ -75990,14 +75897,107 @@ } } }, - "discussion-edited": { + "discussion-closed": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "description": "A discussion was closed.", + "operationId": "discussion/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussions", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-comment-created": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + }, "parameters": [ { "name": "User-Agent", @@ -76061,7 +76061,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-comment-created" } } } @@ -76074,7 +76074,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -76083,11 +76083,197 @@ } } }, - "discussion-labeled": { + "discussion-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-comment-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-created": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76154,7 +76340,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-created" } } } @@ -76176,11 +76362,11 @@ } } }, - "discussion-locked": { + "discussion-deleted": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76247,7 +76433,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-deleted" } } } @@ -76269,11 +76455,11 @@ } } }, - "discussion-pinned": { + "discussion-edited": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76340,7 +76526,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-edited" } } } @@ -76362,11 +76548,11 @@ } } }, - "discussion-reopened": { + "discussion-labeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was reopened.", - "operationId": "discussion/reopened", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76390,7 +76576,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -76433,7 +76619,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-labeled" } } } @@ -76455,11 +76641,11 @@ } } }, - "discussion-transferred": { + "discussion-locked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76526,7 +76712,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-locked" } } } @@ -76548,11 +76734,11 @@ } } }, - "discussion-unanswered": { + "discussion-pinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76619,7 +76805,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-discussion-pinned" } } } @@ -76641,11 +76827,11 @@ } } }, - "discussion-unlabeled": { + "discussion-reopened": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76669,7 +76855,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -76712,7 +76898,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-discussion-reopened" } } } @@ -76734,11 +76920,11 @@ } } }, - "discussion-unlocked": { + "discussion-transferred": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76805,7 +76991,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-discussion-transferred" } } } @@ -76827,11 +77013,11 @@ } } }, - "discussion-unpinned": { + "discussion-unanswered": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76898,7 +77084,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-discussion-unanswered" } } } @@ -76920,12 +77106,13 @@ } } }, - "fork": { + "discussion-unlabeled": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "fork", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -76990,7 +77177,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" } } } @@ -77003,9 +77190,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "discussion", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -77013,13 +77199,13 @@ } } }, - "github-app-authorization-revoked": { + "discussion-unlocked": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -77084,7 +77270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + "$ref": "#/components/schemas/webhook-discussion-unlocked" } } } @@ -77097,19 +77283,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "github_app_authorization", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "gollum": { + "discussion-unpinned": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -77174,7 +77363,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-discussion-unpinned" } } } @@ -77187,7 +77376,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -77196,13 +77385,12 @@ } } }, - "installation-created": { + "fork": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -77267,7 +77455,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-fork" } } } @@ -77280,20 +77468,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "fork", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "installation-deleted": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -77358,7 +77549,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" } } } @@ -77371,20 +77562,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "github_app_authorization", "supported-webhook-types": [ "app" ] } } }, - "installation-new-permissions-accepted": { + "gollum": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -77449,7 +77639,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-gollum" } } } @@ -77462,20 +77652,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "gollum", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-repositories-added": { + "installation-created": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -77540,7 +77732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-installation-created" } } } @@ -77553,20 +77745,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-repositories-removed": { + "installation-deleted": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -77631,7 +77823,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-installation-deleted" } } } @@ -77644,18 +77836,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-suspend": { + "installation-new-permissions-accepted": { "post": { "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, @@ -77722,7 +77914,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" } } } @@ -77742,13 +77934,13 @@ } } }, - "installation-target-renamed": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -77813,7 +78005,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-installation-repositories-added" } } } @@ -77826,20 +78018,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_target", + "subcategory": "installation_repositories", "supported-webhook-types": [ "app" ] } } }, - "installation-unsuspend": { + "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -77904,7 +78096,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" } } } @@ -77917,20 +78109,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation_repositories", "supported-webhook-types": [ "app" ] } } }, - "issue-comment-created": { + "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -77995,7 +78187,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-installation-suspend" } } } @@ -78008,22 +78200,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-deleted": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -78088,7 +78278,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-installation-target-renamed" } } } @@ -78101,22 +78291,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "installation_target", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-edited": { + "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -78181,7 +78369,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-installation-unsuspend" } } } @@ -78194,22 +78382,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-assigned": { + "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -78274,7 +78460,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-comment-created" } } } @@ -78287,7 +78473,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -78296,13 +78482,13 @@ } } }, - "issues-closed": { + "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -78367,7 +78553,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" } } } @@ -78380,7 +78566,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -78389,13 +78575,13 @@ } } }, - "issues-deleted": { + "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -78460,7 +78646,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-comment-edited" } } } @@ -78473,7 +78659,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -78482,11 +78668,11 @@ } } }, - "issues-demilestoned": { + "issues-assigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78553,7 +78739,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -78575,11 +78761,11 @@ } } }, - "issues-edited": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78646,7 +78832,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -78668,11 +78854,11 @@ } } }, - "issues-labeled": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78739,7 +78925,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -78761,11 +78947,11 @@ } } }, - "issues-locked": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78832,7 +79018,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -78854,11 +79040,11 @@ } } }, - "issues-milestoned": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78925,7 +79111,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -78947,11 +79133,11 @@ } } }, - "issues-opened": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79018,7 +79204,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -79040,11 +79226,11 @@ } } }, - "issues-pinned": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79111,7 +79297,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -79133,11 +79319,11 @@ } } }, - "issues-reopened": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79204,7 +79390,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -79226,11 +79412,11 @@ } } }, - "issues-transferred": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79297,7 +79483,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -79319,11 +79505,11 @@ } } }, - "issues-unassigned": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79390,7 +79576,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -79412,11 +79598,11 @@ } } }, - "issues-unlabeled": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79483,7 +79669,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -79505,11 +79691,11 @@ } } }, - "issues-unlocked": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79576,7 +79762,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -79598,11 +79784,11 @@ } } }, - "issues-unpinned": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79669,7 +79855,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -79691,13 +79877,13 @@ } } }, - "label-created": { + "issues-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -79762,7 +79948,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -79775,7 +79961,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -79784,13 +79970,13 @@ } } }, - "label-deleted": { + "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -79855,7 +80041,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -79868,7 +80054,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -79877,11 +80063,104 @@ } } }, - "label-edited": { + "issues-unpinned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-unpinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-created": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, @@ -79948,7 +80227,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -79970,13 +80249,13 @@ } } }, - "marketplace-purchase-cancelled": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -80041,7 +80320,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -80054,20 +80333,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -80132,7 +80413,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -80145,18 +80426,202 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "marketplace-purchase-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "marketplace-purchase-changed": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "marketplace-purchase-pending-change": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -133713,6 +134178,241 @@ "authorized_actor_names" ] }, + "exemption-request-push-ruleset-bypass": { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + "exemption-request-secret-scanning": { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "exemption-request-secret-scanning-metadata": { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + }, + "exemption-response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, + "exemption-request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" + }, + { + "$ref": "#/components/schemas/exemption-request-secret-scanning" + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "$ref": "#/components/schemas/exemption-response" + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", "type": "object", @@ -145652,6 +146352,189 @@ "sender" ] }, + "webhook-exemption-request-cancelled": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-completed": { + "title": "Exemption request completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-created": { + "title": "Exemption request created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-response-dismissed": { + "title": "Exemption response dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_dismissed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, + "webhook-exemption-request-response-submitted": { + "title": "Exemption response submitted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_submitted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, "webhook-check-run-completed": { "title": "Check Run Completed Event", "type": "object", diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 1cbef86c65..c2d84f78ca 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -51835,6 +51835,347 @@ webhooks: - repository - organization - app + bypass-request-secret-scanning-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was cancelled. + operationId: exemption-request-secret-scanning/cancelled + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning bypass request was completed. + operationId: exemption-request-secret-scanning/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was created. + operationId: exemption-request-secret-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass response was dismissed. + operationId: exemption-request-secret-scanning/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A response either approving or rejecting the secret scanning push + protection bypass request was submitted. + operationId: exemption-request-secret-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app check-run-completed: post: summary: |- @@ -96515,6 +96856,180 @@ components: - required_conversation_resolution_level - authorized_actors_only - authorized_actor_names + exemption-request-push-ruleset-bypass: + title: Push ruleset bypass exemption request data + description: Push rules that are being requested to be bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - push_ruleset_bypass + data: + type: array + description: The data pertaining to the push rules that are being requested + to be bypassed. + items: + type: object + properties: + ruleset_id: + type: integer + description: The ID of the ruleset for the rules that were violated + ruleset_name: + type: string + description: The name of the ruleset for the rules that were violated + total_violations: + type: integer + description: The number of violations + rule_type: + type: string + description: The type of rule that was violated + exemption-request-secret-scanning: + title: Secret scanning push protection exemption request data + description: Secret scanning push protections that are being requested to be + bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - secret_scanning + data: + type: array + description: The data pertaining to the secret scanning push protections + that are being requested to be bypassed. + items: + type: object + properties: + secret_type: + type: string + description: The type of secret that was detected + commits: + type: array + description: The commits that introduced the secret + items: + type: string + exemption-request-secret-scanning-metadata: + title: Secret Scanning Push Protection Exemption Request Metadata + description: Metadata for a secret scanning push protection exemption request. + type: object + properties: + label: + type: string + description: The label for the secret type + reason: + type: string + description: The reason for the exemption request + enum: + - fixed_later + - false_positive + - tests + exemption-response: + title: Exemption response + description: A response to an exemption request by a delegated bypasser. + type: object + properties: + id: + type: integer + description: The ID of the exemption response. + reviewer_id: + type: integer + description: The ID of the user who reviewed the exemption request. + reviewer_login: + type: string + description: The login of the user who reviewed the exemption request. + status: + type: string + description: The status of the exemption response. + enum: + - approved + - rejected + - dismissed + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + exemption-request: + title: Exemption Request + description: A request from a user to be exempted from a set of rules. + type: object + properties: + id: + type: integer + description: The ID of the exemption request. + number: + type: integer + description: The number uniquely identifying the exemption request within + it's repository. + repository_id: + type: integer + description: The ID of the repository the exemption request is for. + requester_id: + type: integer + description: The ID of the user who requested the exemption. + requester_login: + type: string + description: The login of the user who requested the exemption. + request_type: + type: string + description: The type of request. + enum: + - push_ruleset_bypass + - secret_scanning + exemption_request_data: + oneOf: + - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" + - "$ref": "#/components/schemas/exemption-request-secret-scanning" + resource_identifier: + type: string + description: The unique identifier for the request type of the exemption + request. For example, a commit SHA. + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + status: + type: string + description: The status of the exemption request. + enum: + - pending + - rejected + - cancelled + - completed + requester_comment: + type: + - string + - 'null' + description: The comment the requester provided when creating the exemption + request. + metadata: + type: + - object + - 'null' + description: Metadata about the exemption request. + oneOf: + - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" + expires_at: + type: string + format: date-time + description: The date and time the exemption request will expire. + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + responses: + type: + - array + - 'null' + description: The responses to the exemption request. + items: + "$ref": "#/components/schemas/exemption-response" + html_url: + type: string + description: The URL to view the exemption request in a browser. + format: uri + examples: + - https://github.com/monalisa/smile/exemptions/1 simple-check-suite: description: A suite of checks performed on the code of a given code change type: object @@ -105387,6 +105902,132 @@ components: - rule - repository - sender + webhook-exemption-request-cancelled: + title: Exemption request cancellation event + type: object + properties: + action: + type: string + enum: + - cancelled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - sender + webhook-exemption-request-completed: + title: Exemption request completed event + type: object + properties: + action: + type: string + enum: + - completed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - sender + webhook-exemption-request-created: + title: Exemption request created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - sender + webhook-exemption-request-response-dismissed: + title: Exemption response dismissed event + type: object + properties: + action: + type: string + enum: + - response_dismissed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + exemption_response: + "$ref": "#/components/schemas/exemption-response" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - exemption_response + - sender + webhook-exemption-request-response-submitted: + title: Exemption response submitted event + type: object + properties: + action: + type: string + enum: + - response_submitted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + exemption_response: + "$ref": "#/components/schemas/exemption-response" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - exemption_response + - sender webhook-check-run-completed: title: Check Run Completed Event type: object diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index f0afd92b7c..d8f070efc4 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -71940,13 +71940,13 @@ } } }, - "check-run-completed": { + "bypass-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run was completed, and a conclusion is available.", - "operationId": "check-run/completed", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass request was cancelled.", + "operationId": "exemption-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72011,22 +72011,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -72038,9 +72023,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72049,13 +72033,13 @@ } } }, - "check-run-created": { + "bypass-request-secret-scanning-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A new check run was created.", - "operationId": "check-run/created", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning bypass request was completed.", + "operationId": "exemption-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72120,22 +72104,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -72147,9 +72116,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72158,13 +72126,13 @@ } } }, - "check-run-requested-action": { + "bypass-request-secret-scanning-created": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", - "operationId": "check-run/requested-action", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass request was created.", + "operationId": "exemption-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72229,22 +72197,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -72256,9 +72209,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72267,13 +72219,13 @@ } } }, - "check-run-rerequested": { + "bypass-request-secret-scanning-response-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", - "operationId": "check-run/rerequested", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A secret scanning push protection bypass response was dismissed.", + "operationId": "exemption-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72338,22 +72290,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -72365,9 +72302,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72376,13 +72312,13 @@ } } }, - "check-suite-completed": { + "bypass-request-secret-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in beta and subject to change.", + "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", + "operationId": "exemption-request-secret-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -72447,7 +72383,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-completed" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -72460,7 +72396,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -72469,13 +72405,13 @@ } } }, - "check-suite-requested": { + "check-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", - "operationId": "check-suite/requested", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", + "operationId": "check-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -72540,7 +72476,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-check-run-completed" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed-form-encoded" + } } } } @@ -72552,8 +72503,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -72562,13 +72514,13 @@ } } }, - "check-suite-rerequested": { + "check-run-created": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", - "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", - "operationId": "check-suite/rerequested", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A new check run was created.", + "operationId": "check-run/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -72633,7 +72585,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-check-run-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created-form-encoded" + } } } } @@ -72645,8 +72612,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -72655,13 +72623,13 @@ } } }, - "code-scanning-alert-appeared-in-branch": { + "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", - "operationId": "code-scanning-alert/appeared-in-branch", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -72726,7 +72694,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-check-run-requested-action" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + } } } } @@ -72738,8 +72721,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -72748,13 +72732,13 @@ } } }, - "code-scanning-alert-closed-by-user": { + "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -72819,7 +72803,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-check-run-rerequested" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested-form-encoded" + } } } } @@ -72831,8 +72830,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -72841,13 +72841,13 @@ } } }, - "code-scanning-alert-created": { + "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -72912,7 +72912,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-check-suite-completed" } } } @@ -72925,7 +72925,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -72934,13 +72934,13 @@ } } }, - "code-scanning-alert-fixed": { + "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -73005,7 +73005,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-check-suite-requested" } } } @@ -73018,7 +73018,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -73027,13 +73027,13 @@ } } }, - "code-scanning-alert-reopened": { + "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -73098,7 +73098,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-check-suite-rerequested" } } } @@ -73111,7 +73111,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -73120,11 +73120,11 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "code-scanning-alert-appeared-in-branch": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -73191,7 +73191,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" } } } @@ -73213,13 +73213,13 @@ } } }, - "commit-comment-created": { + "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "Someone commented on a commit.", - "operationId": "commit-comment/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73284,7 +73284,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" } } } @@ -73297,7 +73297,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "commit_comment", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -73306,12 +73306,13 @@ } } }, - "create": { + "code-scanning-alert-created": { "post": { - "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", - "operationId": "create", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73376,7 +73377,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" } } } @@ -73389,7 +73390,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "create", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -73398,197 +73399,13 @@ } } }, - "custom-property-created": { - "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A new custom property was created.", - "operationId": "custom-property/created", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-custom-property-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "custom_property", - "supported-webhook-types": [ - "organization", - "app" - ] - } - } - }, - "custom-property-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was deleted.", - "operationId": "custom-property/deleted", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-custom-property-deleted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "custom_property", - "supported-webhook-types": [ - "organization", - "app" - ] - } - } - }, - "custom-property-updated": { + "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was updated.", - "operationId": "custom-property/updated", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73653,7 +73470,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-updated" + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" } } } @@ -73666,21 +73483,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom_property", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ + "repository", "organization", "app" ] } } }, - "custom-property-values-updated": { + "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "The custom property values of a repository were updated.", - "operationId": "custom-property-values/updated", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73745,7 +73563,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" } } } @@ -73758,7 +73576,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom-property-values", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -73767,12 +73585,13 @@ } } }, - "delete": { + "code-scanning-alert-reopened-by-user": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", - "operationId": "delete", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -73837,7 +73656,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" } } } @@ -73850,7 +73669,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "delete", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -73859,13 +73678,13 @@ } } }, - "dependabot-alert-auto-dismissed": { + "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", - "operationId": "dependabot-alert/auto-dismissed", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -73930,7 +73749,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-commit-comment-created" } } } @@ -73943,7 +73762,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "commit_comment", "supported-webhook-types": [ "repository", "organization", @@ -73952,13 +73771,12 @@ } } }, - "dependabot-alert-auto-reopened": { + "create": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", - "operationId": "dependabot-alert/auto-reopened", + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", + "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -74023,7 +73841,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-create" } } } @@ -74036,7 +73854,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "create", "supported-webhook-types": [ "repository", "organization", @@ -74045,13 +73863,13 @@ } } }, - "dependabot-alert-created": { + "custom-property-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A new custom property was created.", + "operationId": "custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -74116,7 +73934,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-custom-property-created" } } } @@ -74129,22 +73947,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", "organization", "app" ] } } }, - "dependabot-alert-dismissed": { + "custom-property-deleted": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was deleted.", + "operationId": "custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -74209,7 +74026,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-custom-property-deleted" } } } @@ -74222,22 +74039,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", "organization", "app" ] } } }, - "dependabot-alert-fixed": { + "custom-property-updated": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was updated.", + "operationId": "custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -74302,7 +74118,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-custom-property-updated" } } } @@ -74315,22 +74131,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", "organization", "app" ] } } }, - "dependabot-alert-reintroduced": { + "custom-property-values-updated": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "The custom property values of a repository were updated.", + "operationId": "custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" }, "parameters": [ { @@ -74395,7 +74210,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" } } } @@ -74408,7 +74223,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "custom-property-values", "supported-webhook-types": [ "repository", "organization", @@ -74417,13 +74232,12 @@ } } }, - "dependabot-alert-reopened": { + "delete": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -74488,7 +74302,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-delete" } } } @@ -74501,7 +74315,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "delete", "supported-webhook-types": [ "repository", "organization", @@ -74510,13 +74324,13 @@ } } }, - "deploy-key-created": { + "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", + "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74581,7 +74395,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" } } } @@ -74594,7 +74408,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -74603,13 +74417,13 @@ } } }, - "deploy-key-deleted": { + "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", + "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74674,7 +74488,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" } } } @@ -74687,7 +74501,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -74696,13 +74510,13 @@ } } }, - "deployment-created": { + "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74767,7 +74581,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" } } } @@ -74780,7 +74594,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -74789,13 +74603,13 @@ } } }, - "deployment-protection-rule-requested": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment protection rule was requested for an environment.", - "operationId": "deployment-protection-rule/requested", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74860,7 +74674,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" } } } @@ -74873,20 +74687,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_protection_rule", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-approved": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was approved.", - "operationId": "deployment-review/approved", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -74951,7 +74767,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" } } } @@ -74964,20 +74780,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-rejected": { + "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was rejected.", - "operationId": "deployment-review/rejected", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -75042,7 +74860,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" } } } @@ -75055,20 +74873,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-requested": { + "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was requested.", - "operationId": "deployment-review/requested", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -75133,7 +74953,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" } } } @@ -75146,20 +74966,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-status-created": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -75224,7 +75046,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-deploy-key-created" } } } @@ -75237,7 +75059,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_status", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -75246,13 +75068,13 @@ } } }, - "discussion-answered": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -75317,7 +75139,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" } } } @@ -75330,7 +75152,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -75339,13 +75161,13 @@ } } }, - "discussion-category-changed": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -75410,7 +75232,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-deployment-created" } } } @@ -75423,7 +75245,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment", "supported-webhook-types": [ "repository", "organization", @@ -75432,13 +75254,13 @@ } } }, - "discussion-closed": { + "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was closed.", - "operationId": "discussion/closed", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -75460,7 +75282,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -75503,7 +75325,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" } } } @@ -75516,22 +75338,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment_protection_rule", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-comment-created": { + "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was approved.", + "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -75596,7 +75416,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-deployment-review-approved" } } } @@ -75609,22 +75429,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-comment-deleted": { + "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was rejected.", + "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -75689,7 +75507,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" } } } @@ -75702,22 +75520,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-comment-edited": { + "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was requested.", + "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -75782,7 +75598,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-deployment-review-requested" } } } @@ -75795,7 +75611,98 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "deployment_review", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "deployment-status-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-status-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_status", "supported-webhook-types": [ "repository", "organization", @@ -75804,11 +75711,11 @@ } } }, - "discussion-created": { + "discussion-answered": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -75875,7 +75782,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-answered" } } } @@ -75897,11 +75804,11 @@ } } }, - "discussion-deleted": { + "discussion-category-changed": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -75968,7 +75875,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-category-changed" } } } @@ -75990,14 +75897,107 @@ } } }, - "discussion-edited": { + "discussion-closed": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "description": "A discussion was closed.", + "operationId": "discussion/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussions", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-comment-created": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + }, "parameters": [ { "name": "User-Agent", @@ -76061,7 +76061,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-comment-created" } } } @@ -76074,7 +76074,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -76083,11 +76083,197 @@ } } }, - "discussion-labeled": { + "discussion-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-comment-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-created": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76154,7 +76340,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-created" } } } @@ -76176,11 +76362,11 @@ } } }, - "discussion-locked": { + "discussion-deleted": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76247,7 +76433,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-deleted" } } } @@ -76269,11 +76455,11 @@ } } }, - "discussion-pinned": { + "discussion-edited": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76340,7 +76526,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-edited" } } } @@ -76362,11 +76548,11 @@ } } }, - "discussion-reopened": { + "discussion-labeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was reopened.", - "operationId": "discussion/reopened", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76390,7 +76576,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -76433,7 +76619,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-labeled" } } } @@ -76455,11 +76641,11 @@ } } }, - "discussion-transferred": { + "discussion-locked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76526,7 +76712,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-locked" } } } @@ -76548,11 +76734,11 @@ } } }, - "discussion-unanswered": { + "discussion-pinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76619,7 +76805,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-discussion-pinned" } } } @@ -76641,11 +76827,11 @@ } } }, - "discussion-unlabeled": { + "discussion-reopened": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76669,7 +76855,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -76712,7 +76898,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-discussion-reopened" } } } @@ -76734,11 +76920,11 @@ } } }, - "discussion-unlocked": { + "discussion-transferred": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76805,7 +76991,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-discussion-transferred" } } } @@ -76827,11 +77013,11 @@ } } }, - "discussion-unpinned": { + "discussion-unanswered": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -76898,7 +77084,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-discussion-unanswered" } } } @@ -76920,12 +77106,13 @@ } } }, - "fork": { + "discussion-unlabeled": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "fork", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -76990,7 +77177,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" } } } @@ -77003,9 +77190,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "discussion", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -77013,13 +77199,13 @@ } } }, - "github-app-authorization-revoked": { + "discussion-unlocked": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -77084,7 +77270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + "$ref": "#/components/schemas/webhook-discussion-unlocked" } } } @@ -77097,19 +77283,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "github_app_authorization", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "gollum": { + "discussion-unpinned": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -77174,7 +77363,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-discussion-unpinned" } } } @@ -77187,7 +77376,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -77196,13 +77385,12 @@ } } }, - "installation-created": { + "fork": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -77267,7 +77455,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-fork" } } } @@ -77280,20 +77468,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "fork", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "installation-deleted": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -77358,7 +77549,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" } } } @@ -77371,20 +77562,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "github_app_authorization", "supported-webhook-types": [ "app" ] } } }, - "installation-new-permissions-accepted": { + "gollum": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -77449,7 +77639,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-gollum" } } } @@ -77462,20 +77652,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "gollum", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-repositories-added": { + "installation-created": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -77540,7 +77732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-installation-created" } } } @@ -77553,20 +77745,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-repositories-removed": { + "installation-deleted": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -77631,7 +77823,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-installation-deleted" } } } @@ -77644,18 +77836,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-suspend": { + "installation-new-permissions-accepted": { "post": { "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, @@ -77722,7 +77914,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" } } } @@ -77742,13 +77934,13 @@ } } }, - "installation-target-renamed": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -77813,7 +78005,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-installation-repositories-added" } } } @@ -77826,20 +78018,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_target", + "subcategory": "installation_repositories", "supported-webhook-types": [ "app" ] } } }, - "installation-unsuspend": { + "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -77904,7 +78096,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" } } } @@ -77917,20 +78109,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation_repositories", "supported-webhook-types": [ "app" ] } } }, - "issue-comment-created": { + "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -77995,7 +78187,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-installation-suspend" } } } @@ -78008,22 +78200,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-deleted": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -78088,7 +78278,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-installation-target-renamed" } } } @@ -78101,22 +78291,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "installation_target", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-edited": { + "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -78181,7 +78369,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-installation-unsuspend" } } } @@ -78194,22 +78382,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-assigned": { + "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -78274,7 +78460,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-comment-created" } } } @@ -78287,7 +78473,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -78296,13 +78482,13 @@ } } }, - "issues-closed": { + "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -78367,7 +78553,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" } } } @@ -78380,7 +78566,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -78389,13 +78575,13 @@ } } }, - "issues-deleted": { + "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -78460,7 +78646,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-comment-edited" } } } @@ -78473,7 +78659,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -78482,11 +78668,11 @@ } } }, - "issues-demilestoned": { + "issues-assigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78553,7 +78739,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -78575,11 +78761,11 @@ } } }, - "issues-edited": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78646,7 +78832,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -78668,11 +78854,11 @@ } } }, - "issues-labeled": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78739,7 +78925,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -78761,11 +78947,11 @@ } } }, - "issues-locked": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78832,7 +79018,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -78854,11 +79040,11 @@ } } }, - "issues-milestoned": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -78925,7 +79111,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -78947,11 +79133,11 @@ } } }, - "issues-opened": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79018,7 +79204,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -79040,11 +79226,11 @@ } } }, - "issues-pinned": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79111,7 +79297,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -79133,11 +79319,11 @@ } } }, - "issues-reopened": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79204,7 +79390,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -79226,11 +79412,11 @@ } } }, - "issues-transferred": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79297,7 +79483,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -79319,11 +79505,11 @@ } } }, - "issues-unassigned": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79390,7 +79576,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -79412,11 +79598,11 @@ } } }, - "issues-unlabeled": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79483,7 +79669,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -79505,11 +79691,11 @@ } } }, - "issues-unlocked": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79576,7 +79762,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -79598,11 +79784,11 @@ } } }, - "issues-unpinned": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -79669,7 +79855,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -79691,13 +79877,13 @@ } } }, - "label-created": { + "issues-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -79762,7 +79948,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -79775,7 +79961,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -79784,13 +79970,13 @@ } } }, - "label-deleted": { + "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -79855,7 +80041,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -79868,7 +80054,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -79877,11 +80063,104 @@ } } }, - "label-edited": { + "issues-unpinned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-unpinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-created": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, @@ -79948,7 +80227,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -79970,13 +80249,13 @@ } } }, - "marketplace-purchase-cancelled": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -80041,7 +80320,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -80054,20 +80333,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -80132,7 +80413,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -80145,18 +80426,202 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "label", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "marketplace-purchase-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "marketplace-purchase-changed": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "marketplace-purchase-pending-change": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -133713,6 +134178,241 @@ "authorized_actor_names" ] }, + "exemption-request-push-ruleset-bypass": { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + "exemption-request-secret-scanning": { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "commits": { + "type": "array", + "description": "The commits that introduced the secret", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "exemption-request-secret-scanning-metadata": { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + }, + "exemption-response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, + "exemption-request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" + }, + { + "$ref": "#/components/schemas/exemption-request-secret-scanning" + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "$ref": "#/components/schemas/exemption-response" + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", "type": "object", @@ -145652,6 +146352,189 @@ "sender" ] }, + "webhook-exemption-request-cancelled": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-completed": { + "title": "Exemption request completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-created": { + "title": "Exemption request created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-response-dismissed": { + "title": "Exemption response dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_dismissed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, + "webhook-exemption-request-response-submitted": { + "title": "Exemption response submitted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_submitted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, "webhook-check-run-completed": { "title": "Check Run Completed Event", "type": "object", diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 1cbef86c65..c2d84f78ca 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -51835,6 +51835,347 @@ webhooks: - repository - organization - app + bypass-request-secret-scanning-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was cancelled. + operationId: exemption-request-secret-scanning/cancelled + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning bypass request was completed. + operationId: exemption-request-secret-scanning/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass request was created. + operationId: exemption-request-secret-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A secret scanning push protection bypass response was dismissed. + operationId: exemption-request-secret-scanning/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in beta and subject to change. + description: A response either approving or rejecting the secret scanning push + protection bypass request was submitted. + operationId: exemption-request-secret-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app check-run-completed: post: summary: |- @@ -96515,6 +96856,180 @@ components: - required_conversation_resolution_level - authorized_actors_only - authorized_actor_names + exemption-request-push-ruleset-bypass: + title: Push ruleset bypass exemption request data + description: Push rules that are being requested to be bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - push_ruleset_bypass + data: + type: array + description: The data pertaining to the push rules that are being requested + to be bypassed. + items: + type: object + properties: + ruleset_id: + type: integer + description: The ID of the ruleset for the rules that were violated + ruleset_name: + type: string + description: The name of the ruleset for the rules that were violated + total_violations: + type: integer + description: The number of violations + rule_type: + type: string + description: The type of rule that was violated + exemption-request-secret-scanning: + title: Secret scanning push protection exemption request data + description: Secret scanning push protections that are being requested to be + bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - secret_scanning + data: + type: array + description: The data pertaining to the secret scanning push protections + that are being requested to be bypassed. + items: + type: object + properties: + secret_type: + type: string + description: The type of secret that was detected + commits: + type: array + description: The commits that introduced the secret + items: + type: string + exemption-request-secret-scanning-metadata: + title: Secret Scanning Push Protection Exemption Request Metadata + description: Metadata for a secret scanning push protection exemption request. + type: object + properties: + label: + type: string + description: The label for the secret type + reason: + type: string + description: The reason for the exemption request + enum: + - fixed_later + - false_positive + - tests + exemption-response: + title: Exemption response + description: A response to an exemption request by a delegated bypasser. + type: object + properties: + id: + type: integer + description: The ID of the exemption response. + reviewer_id: + type: integer + description: The ID of the user who reviewed the exemption request. + reviewer_login: + type: string + description: The login of the user who reviewed the exemption request. + status: + type: string + description: The status of the exemption response. + enum: + - approved + - rejected + - dismissed + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + exemption-request: + title: Exemption Request + description: A request from a user to be exempted from a set of rules. + type: object + properties: + id: + type: integer + description: The ID of the exemption request. + number: + type: integer + description: The number uniquely identifying the exemption request within + it's repository. + repository_id: + type: integer + description: The ID of the repository the exemption request is for. + requester_id: + type: integer + description: The ID of the user who requested the exemption. + requester_login: + type: string + description: The login of the user who requested the exemption. + request_type: + type: string + description: The type of request. + enum: + - push_ruleset_bypass + - secret_scanning + exemption_request_data: + oneOf: + - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" + - "$ref": "#/components/schemas/exemption-request-secret-scanning" + resource_identifier: + type: string + description: The unique identifier for the request type of the exemption + request. For example, a commit SHA. + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + status: + type: string + description: The status of the exemption request. + enum: + - pending + - rejected + - cancelled + - completed + requester_comment: + type: + - string + - 'null' + description: The comment the requester provided when creating the exemption + request. + metadata: + type: + - object + - 'null' + description: Metadata about the exemption request. + oneOf: + - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" + expires_at: + type: string + format: date-time + description: The date and time the exemption request will expire. + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + responses: + type: + - array + - 'null' + description: The responses to the exemption request. + items: + "$ref": "#/components/schemas/exemption-response" + html_url: + type: string + description: The URL to view the exemption request in a browser. + format: uri + examples: + - https://github.com/monalisa/smile/exemptions/1 simple-check-suite: description: A suite of checks performed on the code of a given code change type: object @@ -105387,6 +105902,132 @@ components: - rule - repository - sender + webhook-exemption-request-cancelled: + title: Exemption request cancellation event + type: object + properties: + action: + type: string + enum: + - cancelled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - sender + webhook-exemption-request-completed: + title: Exemption request completed event + type: object + properties: + action: + type: string + enum: + - completed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - sender + webhook-exemption-request-created: + title: Exemption request created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - sender + webhook-exemption-request-response-dismissed: + title: Exemption response dismissed event + type: object + properties: + action: + type: string + enum: + - response_dismissed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + exemption_response: + "$ref": "#/components/schemas/exemption-response" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - exemption_response + - sender + webhook-exemption-request-response-submitted: + title: Exemption response submitted event + type: object + properties: + action: + type: string + enum: + - response_submitted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + exemption_response: + "$ref": "#/components/schemas/exemption-response" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - exemption_request + - exemption_response + - sender webhook-check-run-completed: title: Check Run Completed Event type: object