diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 145f477296..84b49ffeb9 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -106361,6 +106361,99 @@ } } }, + "pull-request-stacked": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "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": "pull_request", + "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-pull-request-stacked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", @@ -133089,6 +133182,9 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -269291,8 +269387,2999 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "$ref": "#/components/schemas/webhooks_review" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "review", + "pull_request", + "repository", + "sender" + ] + }, + "webhook-pull-request-review-thread-resolved": { + "title": "pull_request_review_thread resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -269754,23 +272841,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "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).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -269970,23 +273040,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_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).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -270042,11 +273095,6 @@ "type": "string", "format": "uri" }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, "visibility": { "type": "string", "enum": [ @@ -270587,23 +273635,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "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).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -270803,23 +273834,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_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).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -270875,11 +273889,6 @@ "type": "string", "format": "uri" }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, "visibility": { "type": "string", "enum": [ @@ -271266,8 +274275,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -271929,29 +274937,425 @@ "repository": { "$ref": "#/components/schemas/repository-webhooks" }, - "review": { - "$ref": "#/components/schemas/webhooks_review" - }, "sender": { "$ref": "#/components/schemas/simple-user" + }, + "thread": { + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": [ + "string", + "null" + ], + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + } + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "comments" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ "action", - "review", + "thread", "pull_request", - "repository", - "sender" + "repository" ] }, - "webhook-pull-request-review-thread-resolved": { - "title": "pull_request_review_thread resolved event", + "webhook-pull-request-review-thread-unresolved": { + "title": "pull_request_review_thread unresolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unresolved" ] }, "enterprise": { @@ -272329,10 +275733,7 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": [ - "string", - "null" - ] + "type": "string" }, "enabled_by": { "title": "User", @@ -273242,10 +276643,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -273253,10 +276651,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -274366,8 +277761,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -274515,16 +277909,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -274781,8 +278166,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -274964,10 +278348,7 @@ }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] + "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies.", @@ -275181,8 +278562,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -275252,14 +278632,14 @@ "repository" ] }, - "webhook-pull-request-review-thread-unresolved": { - "title": "pull_request_review_thread unresolved event", + "webhook-pull-request-stacked": { + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unresolved" + "stacked" ] }, "enterprise": { @@ -275268,11 +278648,14 @@ "installation": { "$ref": "#/components/schemas/simple-installation" }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { - "title": "Simple Pull Request", + "title": "Pull Request", "type": "object", "properties": { "_links": { @@ -275407,6 +278790,9 @@ null ] }, + "additions": { + "type": "integer" + }, "assignee": { "title": "User", "type": [ @@ -275490,7 +278876,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -275591,7 +278978,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -275637,7 +279025,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -276050,6 +279441,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -276249,6 +279657,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -276304,6 +279729,11 @@ "type": "string", "format": "uri" }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, "visibility": { "type": "string", "enum": [ @@ -276519,35 +279949,53 @@ "null" ] }, + "changed_files": { + "type": "integer" + }, "closed_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" + }, + "comments": { + "type": "integer" }, "comments_url": { "type": "string", "format": "uri" }, + "commits": { + "type": "integer" + }, "commits_url": { "type": "string", "format": "uri" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" }, "diff_url": { "type": "string", "format": "uri" }, "draft": { + "description": "Indicates whether or not the pull request is a draft.", "type": "boolean" }, "head": { "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -276555,7 +280003,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -276838,6 +280289,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -277037,6 +280505,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -277092,6 +280577,11 @@ "type": "string", "format": "uri" }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, "visibility": { "type": "string", "enum": [ @@ -277361,16 +280851,136 @@ "locked": { "type": "boolean" }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, "merge_commit_sha": { "type": [ "string", "null" ] }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, "merged_at": { "type": [ "string", "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "milestone": { @@ -277478,7 +281088,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277572,12 +281183,19 @@ "type": "string" }, "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, "patch_url": { "type": "string", "format": "uri" }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, "requested_reviewers": { "type": "array", "items": { @@ -277665,7 +281283,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277813,7 +281432,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -277961,11 +281589,15 @@ "type": "string", "format": "uri-template" }, + "review_comments": { + "type": "integer" + }, "review_comments_url": { "type": "string", "format": "uri" }, "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", "enum": [ "open", @@ -277977,10 +281609,12 @@ "format": "uri" }, "title": { + "description": "The title of the pull request.", "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "url": { "type": "string", @@ -278070,7 +281704,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -278112,7 +281747,6 @@ "requested_teams", "labels", "milestone", - "draft", "commits_url", "review_comments_url", "review_comment_url", @@ -278123,7 +281757,8 @@ "_links", "author_association", "auto_merge", - "active_lock_reason" + "active_lock_reason", + "draft" ] }, "repository": { @@ -278131,409 +281766,14 @@ }, "sender": { "$ref": "#/components/schemas/simple-user" - }, - "thread": { - "type": "object", - "properties": { - "comments": { - "type": "array", - "items": { - "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", - "type": "integer" - }, - "original_start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": "string", - "enum": [ - "LEFT", - "RIGHT" - ] - }, - "start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": [ - "string", - "null" - ], - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the pull request review comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links", - "start_line", - "original_start_line", - "original_line", - "line", - "start_side", - "side", - "reactions" - ] - } - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "node_id", - "comments" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ "action", - "thread", + "number", "pull_request", - "repository" + "repository", + "sender" ] }, "webhook-pull-request-synchronize": { diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index d98160d6a2..cc9a8ec50e 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -77294,6 +77294,72 @@ webhooks: - repository - organization - app + pull-request-stacked: + post: + summary: |- + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was added to a stack. + operationId: pull-request/stacked + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + 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: pull_request + 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-pull-request-stacked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app pull-request-synchronize: post: summary: |- @@ -97047,6 +97113,8 @@ components: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" require_code_owner_review: type: boolean description: Require an approving review in pull requests that modify @@ -197187,53 +197255,2323 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: - "$ref": "#/components/schemas/simple-user" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-review-submitted: - title: pull_request_review submitted event + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: + "$ref": "#/components/schemas/simple-user" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-submitted: + title: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: + - string + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: + "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - review + - pull_request + - repository + - sender + webhook-pull-request-review-thread-resolved: + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -197401,7 +199739,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -197475,7 +199812,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -197815,28 +200151,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -197976,28 +200290,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -198038,12 +200330,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -198459,28 +200745,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -198620,28 +200884,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -198682,12 +200924,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -198991,7 +201227,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -199486,24 +201721,331 @@ components: - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" - review: - "$ref": "#/components/schemas/webhooks_review" sender: "$ref": "#/components/schemas/simple-user" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender - webhook-pull-request-review-thread-resolved: - title: pull_request_review_thread resolved event + webhook-pull-request-review-thread-unresolved: + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -199777,9 +202319,7 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -200457,17 +202997,13 @@ components: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -201296,7 +203832,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201407,15 +203942,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -201605,7 +204131,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201751,9 +204276,7 @@ components: original_line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -201920,7 +204443,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201970,22 +204492,24 @@ components: - thread - pull_request - repository - webhook-pull-request-review-thread-unresolved: - title: pull_request_review_thread unresolved event + webhook-pull-request-stacked: + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -202082,6 +204606,8 @@ components: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -202145,6 +204671,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -202218,6 +204745,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -202251,7 +204779,9 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -202555,6 +205085,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -202694,6 +205246,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -202734,6 +205308,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -202908,34 +205488,49 @@ components: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -203145,6 +205740,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -203284,6 +205901,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -203324,6 +205963,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -203539,14 +206184,100 @@ components: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean merge_commit_sha: type: - string - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -203627,6 +206358,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203694,10 +206426,16 @@ components: node_id: type: string number: + description: Number uniquely identifying the pull request within its + repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -203764,6 +206502,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203874,6 +206613,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -203981,10 +206729,13 @@ components: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -203993,9 +206744,11 @@ components: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -204063,6 +206816,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -204096,7 +206850,6 @@ components: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -204108,322 +206861,17 @@ components: - author_association - auto_merge - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender webhook-pull-request-synchronize: title: pull_request synchronize event type: object diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 075af3fc59..f3c3571766 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -106240,11 +106240,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -106311,7 +106311,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-stacked" } } } @@ -106333,11 +106333,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -106404,7 +106404,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -106426,11 +106426,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -106497,7 +106497,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -106519,11 +106519,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -106590,7 +106590,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -106612,12 +106612,13 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -106639,7 +106640,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -106682,7 +106683,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -106695,7 +106696,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -106704,13 +106705,12 @@ } } }, - "registry-package-published": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -106732,7 +106732,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "registry_package", + "example": "push", "schema": { "type": "string" } @@ -106775,7 +106775,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-push" } } } @@ -106788,7 +106788,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -106797,11 +106797,11 @@ } } }, - "registry-package-updated": { + "registry-package-published": { "post": { "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, @@ -106868,7 +106868,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -106890,292 +106890,13 @@ } } }, - "release-created": { - "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" - }, - "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": "release", - "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-release-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "release", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "release-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" - }, - "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": "release", - "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-release-deleted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "release", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "release-edited": { - "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" - }, - "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": "release", - "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-release-edited" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "release", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "release-prereleased": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -107197,7 +106918,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -107240,7 +106961,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -107253,7 +106974,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -107262,11 +106983,11 @@ } } }, - "release-published": { + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -107333,7 +107054,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -107355,11 +107076,11 @@ } } }, - "release-released": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -107426,7 +107147,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -107448,11 +107169,11 @@ } } }, - "release-unpublished": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -107519,7 +107240,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -107541,13 +107262,13 @@ } } }, - "repository-advisory-published": { + "release-prereleased": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -107569,7 +107290,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -107612,7 +107333,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -107625,7 +107346,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -107634,13 +107355,13 @@ } } }, - "repository-advisory-reported": { + "release-published": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -107662,7 +107383,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_advisory", + "example": "release", "schema": { "type": "string" } @@ -107705,7 +107426,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -107718,7 +107439,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -107727,13 +107448,13 @@ } } }, - "repository-archived": { + "release-released": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -107755,7 +107476,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "release", "schema": { "type": "string" } @@ -107798,7 +107519,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -107811,9 +107532,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -107821,13 +107541,13 @@ } } }, - "repository-created": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -107849,7 +107569,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "release", "schema": { "type": "string" } @@ -107892,7 +107612,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -107905,9 +107625,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -107915,13 +107634,13 @@ } } }, - "repository-deleted": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -107943,7 +107662,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_advisory", "schema": { "type": "string" } @@ -107986,7 +107705,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -107999,9 +107718,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -108009,12 +107727,13 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-advisory-reported": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -108036,7 +107755,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_dispatch", + "example": "repository_advisory", "schema": { "type": "string" } @@ -108079,7 +107798,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -108092,18 +107811,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository_advisory", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "repository-archived": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "A repository was archived.", + "operationId": "repository/archived", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -108170,7 +107891,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -108193,102 +107914,11 @@ } } }, - "repository-import": { - "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", - "operationId": "repository-import", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" - }, - "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": "repository_import", - "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-repository-import" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_import", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-privatized": { + "repository-created": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -108355,7 +107985,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -108378,11 +108008,11 @@ } } }, - "repository-publicized": { + "repository-deleted": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -108449,7 +108079,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -108472,13 +108102,12 @@ } } }, - "repository-renamed": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -108500,7 +108129,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_dispatch", "schema": { "type": "string" } @@ -108543,7 +108172,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -108556,23 +108185,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "repository-ruleset-created": { + "repository-edited": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -108594,7 +108220,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -108637,7 +108263,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -108650,8 +108276,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -108659,13 +108286,12 @@ } } }, - "repository-ruleset-deleted": { + "repository-import": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -108687,7 +108313,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository_import", "schema": { "type": "string" } @@ -108730,7 +108356,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -108743,22 +108369,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository_import", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "repository-ruleset-edited": { + "repository-privatized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -108780,7 +108405,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -108823,7 +108448,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -108836,8 +108461,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -108845,11 +108471,11 @@ } } }, - "repository-transferred": { + "repository-publicized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -108916,7 +108542,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -108939,11 +108565,11 @@ } } }, - "repository-unarchived": { + "repository-renamed": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -109010,7 +108636,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -109033,13 +108659,13 @@ } } }, - "repository-vulnerability-alert-create": { + "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -109061,7 +108687,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "repository_ruleset", "schema": { "type": "string" } @@ -109104,7 +108730,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -109117,21 +108743,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository_ruleset", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-dismiss": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -109153,7 +108780,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "repository_ruleset", "schema": { "type": "string" } @@ -109196,7 +108823,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -109209,21 +108836,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository_ruleset", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-reopen": { + "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -109245,7 +108873,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "repository_ruleset", "schema": { "type": "string" } @@ -109288,7 +108916,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -109301,21 +108929,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository_ruleset", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -109337,103 +108966,11 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", - "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-repository-vulnerability-alert-resolve" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "secret-scanning-alert-assigned": { - "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was assigned.", - "operationId": "secret-scanning-alert/assigned", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" - }, - "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": "secret_scanning_alert", - "schema": { - "type": "string" - } - }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", @@ -109472,7 +109009,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -109485,8 +109022,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -109494,13 +109032,13 @@ } } }, - "secret-scanning-alert-created": { + "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -109522,7 +109060,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "repository", "schema": { "type": "string" } @@ -109565,7 +109103,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -109578,8 +109116,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -109587,13 +109126,13 @@ } } }, - "secret-scanning-alert-location-created": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -109615,7 +109154,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -109658,22 +109197,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -109685,24 +109209,22 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-publicly-leaked": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -109724,7 +109246,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -109767,7 +109289,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -109780,22 +109302,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-reopened": { + "repository-vulnerability-alert-reopen": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -109817,7 +109338,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -109860,7 +109381,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -109873,20 +109394,111 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-resolved": { + "repository-vulnerability-alert-resolve": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "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": "repository_vulnerability_alert", + "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-repository-vulnerability-alert-resolve" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -109953,7 +109565,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -109975,11 +109587,11 @@ } } }, - "secret-scanning-alert-unassigned": { + "secret-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was unassigned.", - "operationId": "secret-scanning-alert/unassigned", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110046,7 +109658,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -110068,13 +109680,13 @@ } } }, - "secret-scanning-alert-validated": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was validated.", - "operationId": "secret-scanning-alert/validated", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -110096,7 +109708,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -110139,7 +109751,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } } } } @@ -110151,8 +109778,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -110161,13 +109789,13 @@ } } }, - "secret-scanning-scan-completed": { + "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning scan was completed.", - "operationId": "secret-scanning-scan/completed", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110189,7 +109817,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_scan", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110232,7 +109860,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -110245,7 +109873,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -110254,13 +109882,13 @@ } } }, - "security-advisory-published": { + "secret-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110282,7 +109910,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110325,7 +109953,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -110338,20 +109966,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "secret-scanning-alert-resolved": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110373,7 +110003,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110416,7 +110046,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -110429,20 +110059,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "secret-scanning-alert-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110464,7 +110096,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110507,7 +110139,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -110520,19 +110152,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-and-analysis": { + "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "operationId": "security-and-analysis", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110554,7 +110189,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_and_analysis", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110597,7 +110232,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -110610,7 +110245,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -110619,13 +110254,13 @@ } } }, - "sponsorship-cancelled": { + "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/cancelled", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning scan was completed.", + "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -110647,7 +110282,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "secret_scanning_scan", "schema": { "type": "string" } @@ -110690,7 +110325,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -110703,20 +110338,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "secret_scanning_scan", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-created": { + "security-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", - "operationId": "sponsorship/created", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -110738,7 +110375,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -110781,7 +110418,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -110794,20 +110431,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-edited": { + "security-advisory-updated": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", - "operationId": "sponsorship/edited", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -110829,7 +110466,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -110872,7 +110509,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -110885,20 +110522,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-pending-cancellation": { + "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/pending-cancellation", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -110920,7 +110557,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -110963,7 +110600,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -110976,18 +110613,110 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-pending-tier-change": { + "security-and-analysis": { + "post": { + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" + }, + "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": "security_and_analysis", + "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-security-and-analysis" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "security_and_analysis", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sponsorship-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", - "operationId": "sponsorship/pending-tier-change", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111054,7 +110783,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -111074,11 +110803,11 @@ } } }, - "sponsorship-tier-changed": { + "sponsorship-created": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", - "operationId": "sponsorship/tier-changed", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111145,7 +110874,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -111165,13 +110894,13 @@ } } }, - "star-created": { + "sponsorship-edited": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone starred a repository.", - "operationId": "star/created", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111193,7 +110922,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111236,7 +110965,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -111249,22 +110978,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "star-deleted": { + "sponsorship-pending-cancellation": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone unstarred the repository.", - "operationId": "star/deleted", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111286,7 +111013,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111329,7 +111056,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -111342,21 +111069,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "status": { + "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", - "operationId": "status", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111378,7 +111104,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "status", + "example": "sponsorship", "schema": { "type": "string" } @@ -111421,7 +111147,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -111434,22 +111160,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "sub-issues-parent-issue-added": { + "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was added to an issue.", - "operationId": "sub-issues/parent-issue-added", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111471,7 +111195,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "sponsorship", "schema": { "type": "string" } @@ -111514,7 +111238,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -111527,22 +111251,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "sub-issues-parent-issue-removed": { + "star-created": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was removed from an issue.", - "operationId": "sub-issues/parent-issue-removed", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone starred a repository.", + "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -111564,7 +111286,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "star", "schema": { "type": "string" } @@ -111607,7 +111329,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -111620,7 +111342,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111629,11 +111351,196 @@ } } }, - "sub-issues-sub-issue-added": { + "star-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + }, + "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": "star", + "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-star-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "star", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "status": { + "post": { + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#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": "status", + "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-status" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "status", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sub-issues-parent-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was added to an issue.", - "operationId": "sub-issues/sub-issue-added", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -111700,7 +111607,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -111722,11 +111629,11 @@ } } }, - "sub-issues-sub-issue-removed": { + "sub-issues-parent-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was removed from an issue.", - "operationId": "sub-issues/sub-issue-removed", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -111793,7 +111700,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -111815,12 +111722,13 @@ } } }, - "team-add": { + "sub-issues-sub-issue-added": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "operationId": "team-add", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -111842,7 +111750,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team_add", + "example": "sub_issues", "schema": { "type": "string" } @@ -111885,7 +111793,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -111898,7 +111806,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -111907,13 +111815,13 @@ } } }, - "team-added-to-repository": { + "sub-issues-sub-issue-removed": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was granted access to a repository.", - "operationId": "team/added-to-repository", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -111935,7 +111843,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "sub_issues", "schema": { "type": "string" } @@ -111978,7 +111886,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -111991,22 +111899,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was created.", - "operationId": "team/created", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -112028,7 +111935,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "team_add", "schema": { "type": "string" } @@ -112071,7 +111978,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -112084,20 +111991,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "team_add", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-deleted": { + "team-added-to-repository": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was deleted.", - "operationId": "team/deleted", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112164,7 +112071,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -112186,11 +112093,11 @@ } } }, - "team-edited": { + "team-created": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name, description, or visibility of a team was changed.", - "operationId": "team/edited", + "description": "A team was created.", + "operationId": "team/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112257,7 +112164,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -112279,11 +112186,11 @@ } } }, - "team-removed-from-repository": { + "team-deleted": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team's access to a repository was removed.", - "operationId": "team/removed-from-repository", + "description": "A team was deleted.", + "operationId": "team/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112350,7 +112257,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -112372,13 +112279,13 @@ } } }, - "watch-started": { + "team-edited": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone started watching the repository.", - "operationId": "watch/started", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -112400,7 +112307,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "watch", + "example": "team", "schema": { "type": "string" } @@ -112443,7 +112350,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -112456,206 +112363,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "watch", + "subcategory": "team", "supported-webhook-types": [ - "repository", "organization", - "app" - ] - } - } - }, - "workflow-dispatch": { - "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "workflow-dispatch", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" - }, - "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": "workflow_dispatch", - "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-workflow-dispatch" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "workflow_dispatch", - "supported-webhook-types": [ - "app" - ] - } - } - }, - "workflow-job-completed": { - "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", - "operationId": "workflow-job/completed", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" - }, - "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": "workflow_job", - "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-workflow-job-completed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "workflow_job", - "supported-webhook-types": [ "business", - "repository", - "organization", "app" ] } } }, - "workflow-job-in-progress": { + "team-removed-from-repository": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run started processing on a runner.", - "operationId": "workflow-job/in-progress", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team's access to a repository was removed.", + "operationId": "team/removed-from-repository", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -112677,7 +112400,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "team", "schema": { "type": "string" } @@ -112720,7 +112443,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -112733,23 +112456,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "team", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } }, - "workflow-job-queued": { + "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created.", - "operationId": "workflow-job/queued", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone started watching the repository.", + "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -112771,7 +112493,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "watch", "schema": { "type": "string" } @@ -112814,7 +112536,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-queued" + "$ref": "#/components/schemas/webhook-watch-started" } } } @@ -112827,9 +112549,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "watch", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -112837,13 +112558,12 @@ } } }, - "workflow-job-waiting": { + "workflow-dispatch": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created and is waiting for approvals.", - "operationId": "workflow-job/waiting", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -112865,7 +112585,380 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "workflow_dispatch", + "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-workflow-dispatch" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "workflow-job-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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": "workflow_job", + "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-workflow-job-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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": "workflow_job", + "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-workflow-job-in-progress" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-queued": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created.", + "operationId": "workflow-job/queued", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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": "workflow_job", + "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-workflow-job-queued" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-waiting": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created and is waiting for approvals.", + "operationId": "workflow-job/waiting", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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": "workflow_job", "schema": { "type": "string" } @@ -132492,6 +132585,9 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -268576,8 +268672,2982 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merged_at": { + "type": [ + "string", + "null" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "$ref": "#/components/schemas/webhooks_review" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "review", + "pull_request", + "repository", + "sender" + ] + }, + "webhook-pull-request-review-thread-resolved": { + "title": "pull_request_review_thread resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -269039,23 +272109,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "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).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -269255,23 +272308,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_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).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -269867,23 +272903,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "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).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -270083,23 +273102,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_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).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -270535,8 +273537,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -271197,29 +274198,425 @@ "repository": { "$ref": "#/components/schemas/repository-webhooks" }, - "review": { - "$ref": "#/components/schemas/webhooks_review" - }, "sender": { "$ref": "#/components/schemas/simple-user" + }, + "thread": { + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": [ + "string", + "null" + ], + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + } + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "comments" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ "action", - "review", + "thread", "pull_request", - "repository", - "sender" + "repository" ] }, - "webhook-pull-request-review-thread-resolved": { - "title": "pull_request_review_thread resolved event", + "webhook-pull-request-review-thread-unresolved": { + "title": "pull_request_review_thread unresolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unresolved" ] }, "enterprise": { @@ -271597,10 +274994,7 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": [ - "string", - "null" - ] + "type": "string" }, "enabled_by": { "title": "User", @@ -272510,10 +275904,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -272521,10 +275912,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -273628,8 +277016,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -273777,16 +277164,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -274043,8 +277421,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -274225,10 +277602,7 @@ }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] + "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies.", @@ -274442,8 +277816,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -274513,14 +277886,14 @@ "repository" ] }, - "webhook-pull-request-review-thread-unresolved": { - "title": "pull_request_review_thread unresolved event", + "webhook-pull-request-stacked": { + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unresolved" + "stacked" ] }, "enterprise": { @@ -274529,11 +277902,14 @@ "installation": { "$ref": "#/components/schemas/simple-installation" }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { - "title": "Simple Pull Request", + "title": "Pull Request", "type": "object", "properties": { "_links": { @@ -274668,6 +278044,9 @@ null ] }, + "additions": { + "type": "integer" + }, "assignee": { "title": "User", "type": [ @@ -274751,7 +278130,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -274852,7 +278232,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -274898,7 +278279,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -275311,6 +278695,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -275510,6 +278911,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -275780,35 +279198,53 @@ "null" ] }, + "changed_files": { + "type": "integer" + }, "closed_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" + }, + "comments": { + "type": "integer" }, "comments_url": { "type": "string", "format": "uri" }, + "commits": { + "type": "integer" + }, "commits_url": { "type": "string", "format": "uri" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" }, "diff_url": { "type": "string", "format": "uri" }, "draft": { + "description": "Indicates whether or not the pull request is a draft.", "type": "boolean" }, "head": { "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -275816,7 +279252,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -276099,6 +279538,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -276298,6 +279754,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -276622,10 +280095,130 @@ "locked": { "type": "boolean" }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, "merged_at": { "type": [ "string", "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "milestone": { @@ -276733,7 +280326,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -276827,12 +280421,19 @@ "type": "string" }, "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, "patch_url": { "type": "string", "format": "uri" }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, "requested_reviewers": { "type": "array", "items": { @@ -276920,7 +280521,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277068,7 +280670,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -277216,11 +280827,15 @@ "type": "string", "format": "uri-template" }, + "review_comments": { + "type": "integer" + }, "review_comments_url": { "type": "string", "format": "uri" }, "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", "enum": [ "open", @@ -277232,10 +280847,12 @@ "format": "uri" }, "title": { + "description": "The title of the pull request.", "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "url": { "type": "string", @@ -277325,7 +280942,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277366,7 +280984,6 @@ "requested_teams", "labels", "milestone", - "draft", "commits_url", "review_comments_url", "review_comment_url", @@ -277377,7 +280994,8 @@ "_links", "author_association", "auto_merge", - "active_lock_reason" + "active_lock_reason", + "draft" ] }, "repository": { @@ -277385,409 +281003,14 @@ }, "sender": { "$ref": "#/components/schemas/simple-user" - }, - "thread": { - "type": "object", - "properties": { - "comments": { - "type": "array", - "items": { - "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", - "type": "integer" - }, - "original_start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": "string", - "enum": [ - "LEFT", - "RIGHT" - ] - }, - "start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": [ - "string", - "null" - ], - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the pull request review comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links", - "start_line", - "original_start_line", - "original_line", - "line", - "start_side", - "side", - "reactions" - ] - } - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "node_id", - "comments" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ "action", - "thread", + "number", "pull_request", - "repository" + "repository", + "sender" ] }, "webhook-pull-request-synchronize": { diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index a847daae31..5d56c84a46 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -77193,6 +77193,72 @@ webhooks: - repository - organization - app + pull-request-stacked: + post: + summary: |- + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was added to a stack. + operationId: pull-request/stacked + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + 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: pull_request + 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-pull-request-stacked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app pull-request-synchronize: post: summary: |- @@ -96608,6 +96674,8 @@ components: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" require_code_owner_review: type: boolean description: Require an approving review in pull requests that modify @@ -196607,53 +196675,2306 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: - "$ref": "#/components/schemas/simple-user" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-review-submitted: - title: pull_request_review submitted event + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: + "$ref": "#/components/schemas/simple-user" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-submitted: + title: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: + "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - review + - pull_request + - repository + - sender + webhook-pull-request-review-thread-resolved: + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -196821,7 +199142,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -196895,7 +199215,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -197235,28 +199554,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -197396,28 +199693,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -197873,28 +200148,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -198034,28 +200287,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -198395,7 +200626,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198889,24 +201119,331 @@ components: - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" - review: - "$ref": "#/components/schemas/webhooks_review" sender: "$ref": "#/components/schemas/simple-user" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender - webhook-pull-request-review-thread-resolved: - title: pull_request_review_thread resolved event + webhook-pull-request-review-thread-unresolved: + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -199180,9 +201717,7 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -199860,17 +202395,13 @@ components: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -200695,7 +203226,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -200806,15 +203336,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -201004,7 +203525,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201149,9 +203669,7 @@ components: original_line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -201318,7 +203836,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -201368,22 +203885,24 @@ components: - thread - pull_request - repository - webhook-pull-request-review-thread-unresolved: - title: pull_request_review_thread unresolved event + webhook-pull-request-stacked: + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -201480,6 +203999,8 @@ components: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -201543,6 +204064,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -201616,6 +204138,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -201649,7 +204172,9 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -201953,6 +204478,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -202092,6 +204639,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -202306,34 +204875,49 @@ components: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -202543,6 +205127,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -202682,6 +205288,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -202937,10 +205565,96 @@ components: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -203021,6 +205735,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203088,10 +205803,16 @@ components: node_id: type: string number: + description: Number uniquely identifying the pull request within its + repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -203158,6 +205879,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203268,6 +205990,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -203375,10 +206106,13 @@ components: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -203387,9 +206121,11 @@ components: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -203457,6 +206193,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203489,7 +206226,6 @@ components: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -203501,322 +206237,17 @@ components: - author_association - auto_merge - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender webhook-pull-request-synchronize: title: pull_request synchronize event type: object diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index c5d6152197..8943570f1c 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -106786,11 +106786,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -106857,7 +106857,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-stacked" } } } @@ -106879,11 +106879,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -106950,7 +106950,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -106972,11 +106972,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -107043,7 +107043,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -107065,11 +107065,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -107136,7 +107136,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -107158,12 +107158,13 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -107185,7 +107186,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -107228,7 +107229,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -107241,7 +107242,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -107250,13 +107251,12 @@ } } }, - "registry-package-published": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -107278,7 +107278,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "registry_package", + "example": "push", "schema": { "type": "string" } @@ -107321,7 +107321,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-push" } } } @@ -107334,7 +107334,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -107343,11 +107343,11 @@ } } }, - "registry-package-updated": { + "registry-package-published": { "post": { "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, @@ -107414,7 +107414,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -107436,13 +107436,13 @@ } } }, - "release-created": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -107464,7 +107464,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "release", + "example": "registry_package", "schema": { "type": "string" } @@ -107507,7 +107507,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -107520,7 +107520,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -107529,11 +107529,11 @@ } } }, - "release-deleted": { + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -107600,7 +107600,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -107622,11 +107622,11 @@ } } }, - "release-edited": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -107693,7 +107693,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -107715,11 +107715,11 @@ } } }, - "release-prereleased": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -107786,7 +107786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -107808,11 +107808,11 @@ } } }, - "release-published": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -107879,7 +107879,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -107901,11 +107901,11 @@ } } }, - "release-released": { + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -107972,7 +107972,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -107994,11 +107994,11 @@ } } }, - "release-unpublished": { + "release-released": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -108065,7 +108065,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -108087,293 +108087,13 @@ } } }, - "repository-advisory-published": { - "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" - }, - "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": "repository_advisory", - "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-repository-advisory-published" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_advisory", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "repository-advisory-reported": { - "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" - }, - "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": "repository_advisory", - "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-repository-advisory-reported" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_advisory", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "repository-archived": { - "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" - }, - "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": "repository", - "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-repository-archived" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository", - "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" - ] - } - } - }, - "repository-created": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" 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.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -108395,7 +108115,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "release", "schema": { "type": "string" } @@ -108438,7 +108158,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -108451,9 +108171,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -108461,11 +108180,197 @@ } } }, - "repository-deleted": { + "repository-advisory-published": { + "post": { + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + }, + "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": "repository_advisory", + "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-repository-advisory-published" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_advisory", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-advisory-reported": { + "post": { + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + }, + "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": "repository_advisory", + "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-repository-advisory-reported" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_advisory", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-archived": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "description": "A repository was archived.", + "operationId": "repository/archived", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -108532,7 +108437,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -108555,12 +108460,13 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-created": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -108582,7 +108488,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_dispatch", + "example": "repository", "schema": { "type": "string" } @@ -108625,7 +108531,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -108638,18 +108544,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "repository-deleted": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -108716,7 +108625,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -108739,12 +108648,12 @@ } } }, - "repository-import": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -108766,7 +108675,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_import", + "example": "repository_dispatch", "schema": { "type": "string" } @@ -108809,7 +108718,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -108822,19 +108731,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "repository", - "organization" + "app" ] } } }, - "repository-privatized": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -108901,7 +108809,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -108924,13 +108832,12 @@ } } }, - "repository-publicized": { + "repository-import": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -108952,7 +108859,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_import", "schema": { "type": "string" } @@ -108995,7 +108902,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -109008,21 +108915,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-renamed": { + "repository-privatized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -109089,7 +108994,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -109112,13 +109017,13 @@ } } }, - "repository-ruleset-created": { + "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -109140,7 +109045,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -109183,7 +109088,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -109196,8 +109101,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -109205,13 +109111,13 @@ } } }, - "repository-ruleset-deleted": { + "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -109233,7 +109139,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_ruleset", + "example": "repository", "schema": { "type": "string" } @@ -109276,7 +109182,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -109289,8 +109195,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -109298,11 +109205,11 @@ } } }, - "repository-ruleset-edited": { + "repository-ruleset-created": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -109369,7 +109276,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -109391,13 +109298,13 @@ } } }, - "repository-transferred": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -109419,7 +109326,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_ruleset", "schema": { "type": "string" } @@ -109462,7 +109369,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -109475,9 +109382,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -109485,13 +109391,13 @@ } } }, - "repository-unarchived": { + "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -109513,7 +109419,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository", + "example": "repository_ruleset", "schema": { "type": "string" } @@ -109556,7 +109462,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -109569,9 +109475,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -109579,13 +109484,13 @@ } } }, - "repository-vulnerability-alert-create": { + "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -109607,7 +109512,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "repository", "schema": { "type": "string" } @@ -109650,7 +109555,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -109663,21 +109568,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-dismiss": { + "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -109699,7 +109606,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "repository_vulnerability_alert", + "example": "repository", "schema": { "type": "string" } @@ -109742,7 +109649,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -109755,19 +109662,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-reopen": { + "repository-vulnerability-alert-create": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -109834,7 +109743,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -109855,11 +109764,11 @@ } } }, - "repository-vulnerability-alert-resolve": { + "repository-vulnerability-alert-dismiss": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -109926,7 +109835,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -109947,13 +109856,13 @@ } } }, - "secret-scanning-alert-assigned": { + "repository-vulnerability-alert-reopen": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was assigned.", - "operationId": "secret-scanning-alert/assigned", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -109975,7 +109884,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -110018,7 +109927,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -110031,22 +109940,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-created": { + "repository-vulnerability-alert-resolve": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -110068,7 +109976,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "repository_vulnerability_alert", "schema": { "type": "string" } @@ -110111,7 +110019,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -110124,22 +110032,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-assigned": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110161,7 +110068,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert_location", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110204,22 +110111,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -110231,9 +110123,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -110242,11 +110133,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110313,7 +110204,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -110335,13 +110226,13 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -110363,7 +110254,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_alert", + "example": "secret_scanning_alert_location", "schema": { "type": "string" } @@ -110406,7 +110297,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } } } } @@ -110418,8 +110324,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -110428,11 +110335,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-publicly-leaked": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110499,7 +110406,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -110521,11 +110428,11 @@ } } }, - "secret-scanning-alert-unassigned": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was unassigned.", - "operationId": "secret-scanning-alert/unassigned", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110592,7 +110499,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -110614,11 +110521,11 @@ } } }, - "secret-scanning-alert-validated": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was validated.", - "operationId": "secret-scanning-alert/validated", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -110685,7 +110592,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -110707,13 +110614,13 @@ } } }, - "secret-scanning-scan-completed": { + "secret-scanning-alert-unassigned": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning scan was completed.", - "operationId": "secret-scanning-scan/completed", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110735,7 +110642,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "secret_scanning_scan", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110778,7 +110685,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -110791,7 +110698,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -110800,13 +110707,13 @@ } } }, - "security-advisory-published": { + "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -110828,7 +110735,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_alert", "schema": { "type": "string" } @@ -110871,7 +110778,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -110884,20 +110791,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning scan was completed.", + "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -110919,7 +110828,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_advisory", + "example": "secret_scanning_scan", "schema": { "type": "string" } @@ -110962,7 +110871,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -110975,18 +110884,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_scan", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "security-advisory-published": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, @@ -111053,7 +110964,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -111073,12 +110984,13 @@ } } }, - "security-and-analysis": { + "security-advisory-updated": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "operationId": "security-and-analysis", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -111100,7 +111012,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "security_and_analysis", + "example": "security_advisory", "schema": { "type": "string" } @@ -111143,7 +111055,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -111156,22 +111068,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "sponsorship-cancelled": { + "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/cancelled", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -111193,7 +111103,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_advisory", "schema": { "type": "string" } @@ -111236,7 +111146,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -111249,20 +111159,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-created": { + "security-and-analysis": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", - "operationId": "sponsorship/created", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -111284,7 +111193,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sponsorship", + "example": "security_and_analysis", "schema": { "type": "string" } @@ -111327,7 +111236,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -111340,18 +111249,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_and_analysis", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-edited": { + "sponsorship-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", - "operationId": "sponsorship/edited", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111418,7 +111329,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -111438,11 +111349,11 @@ } } }, - "sponsorship-pending-cancellation": { + "sponsorship-created": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/pending-cancellation", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111509,7 +111420,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -111529,11 +111440,11 @@ } } }, - "sponsorship-pending-tier-change": { + "sponsorship-edited": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", - "operationId": "sponsorship/pending-tier-change", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111600,7 +111511,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -111620,11 +111531,11 @@ } } }, - "sponsorship-tier-changed": { + "sponsorship-pending-cancellation": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", - "operationId": "sponsorship/tier-changed", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -111691,7 +111602,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -111711,13 +111622,13 @@ } } }, - "star-created": { + "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone starred a repository.", - "operationId": "star/created", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111739,7 +111650,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111782,7 +111693,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -111795,22 +111706,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "star-deleted": { + "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone unstarred the repository.", - "operationId": "star/deleted", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -111832,7 +111741,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "star", + "example": "sponsorship", "schema": { "type": "string" } @@ -111875,7 +111784,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -111888,21 +111797,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "status": { + "star-created": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", - "operationId": "status", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone starred a repository.", + "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -111924,7 +111832,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "status", + "example": "star", "schema": { "type": "string" } @@ -111967,7 +111875,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -111980,7 +111888,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -111989,13 +111897,13 @@ } } }, - "sub-issues-parent-issue-added": { + "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was added to an issue.", - "operationId": "sub-issues/parent-issue-added", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -112017,7 +111925,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "star", "schema": { "type": "string" } @@ -112060,7 +111968,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -112073,7 +111981,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -112082,13 +111990,12 @@ } } }, - "sub-issues-parent-issue-removed": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A parent issue was removed from an issue.", - "operationId": "sub-issues/parent-issue-removed", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -112110,7 +112017,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "sub_issues", + "example": "status", "schema": { "type": "string" } @@ -112153,7 +112060,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" } } } @@ -112166,7 +112073,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -112175,11 +112082,11 @@ } } }, - "sub-issues-sub-issue-added": { + "sub-issues-parent-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was added to an issue.", - "operationId": "sub-issues/sub-issue-added", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -112246,7 +112153,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -112268,11 +112175,11 @@ } } }, - "sub-issues-sub-issue-removed": { + "sub-issues-parent-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "A sub-issue was removed from an issue.", - "operationId": "sub-issues/sub-issue-removed", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, @@ -112339,7 +112246,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -112361,12 +112268,13 @@ } } }, - "team-add": { + "sub-issues-sub-issue-added": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "operationId": "team-add", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -112388,7 +112296,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team_add", + "example": "sub_issues", "schema": { "type": "string" } @@ -112431,7 +112339,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -112444,7 +112352,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -112453,13 +112361,13 @@ } } }, - "team-added-to-repository": { + "sub-issues-sub-issue-removed": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was granted access to a repository.", - "operationId": "team/added-to-repository", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -112481,7 +112389,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "team", + "example": "sub_issues", "schema": { "type": "string" } @@ -112524,7 +112432,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -112537,20 +112445,112 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "team-add": { + "post": { + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" + }, + "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": "team_add", + "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-team-add" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team_add", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "team-added-to-repository": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was created.", - "operationId": "team/created", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112617,7 +112617,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -112639,11 +112639,11 @@ } } }, - "team-deleted": { + "team-created": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was deleted.", - "operationId": "team/deleted", + "description": "A team was created.", + "operationId": "team/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112710,7 +112710,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -112732,11 +112732,11 @@ } } }, - "team-edited": { + "team-deleted": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name, description, or visibility of a team was changed.", - "operationId": "team/edited", + "description": "A team was deleted.", + "operationId": "team/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112803,7 +112803,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -112825,11 +112825,11 @@ } } }, - "team-removed-from-repository": { + "team-edited": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team's access to a repository was removed.", - "operationId": "team/removed-from-repository", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, @@ -112896,7 +112896,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -112918,13 +112918,13 @@ } } }, - "watch-started": { + "team-removed-from-repository": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone started watching the repository.", - "operationId": "watch/started", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team's access to a repository was removed.", + "operationId": "team/removed-from-repository", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -112946,7 +112946,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "watch", + "example": "team", "schema": { "type": "string" } @@ -112989,7 +112989,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -113002,21 +113002,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "watch", + "subcategory": "team", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "workflow-dispatch": { + "watch-started": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "workflow-dispatch", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone started watching the repository.", + "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -113038,7 +113039,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_dispatch", + "example": "watch", "schema": { "type": "string" } @@ -113081,7 +113082,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-watch-started" } } } @@ -113094,20 +113095,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_dispatch", + "subcategory": "watch", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "workflow-job-completed": { + "workflow-dispatch": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", - "operationId": "workflow-job/completed", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -113129,7 +113131,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_job", + "example": "workflow_dispatch", "schema": { "type": "string" } @@ -113172,7 +113174,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-workflow-dispatch" } } } @@ -113185,21 +113187,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "workflow_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "workflow-job-in-progress": { + "workflow-job-completed": { "post": { "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run started processing on a runner.", - "operationId": "workflow-job/in-progress", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" }, @@ -113266,7 +113265,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + "$ref": "#/components/schemas/webhook-workflow-job-completed" } } } @@ -113289,11 +113288,11 @@ } } }, - "workflow-job-queued": { + "workflow-job-in-progress": { "post": { "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created.", - "operationId": "workflow-job/queued", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" }, @@ -113360,7 +113359,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-queued" + "$ref": "#/components/schemas/webhook-workflow-job-in-progress" } } } @@ -113383,11 +113382,11 @@ } } }, - "workflow-job-waiting": { + "workflow-job-queued": { "post": { "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created and is waiting for approvals.", - "operationId": "workflow-job/waiting", + "description": "A job in a workflow run was created.", + "operationId": "workflow-job/queued", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" }, @@ -113454,7 +113453,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-waiting" + "$ref": "#/components/schemas/webhook-workflow-job-queued" } } } @@ -113477,13 +113476,13 @@ } } }, - "workflow-run-completed": { + "workflow-job-waiting": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", - "operationId": "workflow-run/completed", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created and is waiting for approvals.", + "operationId": "workflow-job/waiting", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -113505,7 +113504,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "workflow_run", + "example": "workflow_job", "schema": { "type": "string" } @@ -113548,7 +113547,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-run-completed" + "$ref": "#/components/schemas/webhook-workflow-job-waiting" } } } @@ -113561,7 +113560,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_run", + "subcategory": "workflow_job", "supported-webhook-types": [ "business", "repository", @@ -113571,11 +113570,105 @@ } } }, - "workflow-run-in-progress": { + "workflow-run-completed": { "post": { "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run started processing on a runner.", - "operationId": "workflow-run/in-progress", + "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", + "operationId": "workflow-run/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + }, + "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": "workflow_run", + "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-workflow-run-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run started processing on a runner.", + "operationId": "workflow-run/in-progress", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" }, @@ -133963,6 +134056,9 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -270973,8 +271069,3029 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": [ + "string", + "null" + ] + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": [ + "string", + "null" + ] + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "$ref": "#/components/schemas/webhooks_review" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "review", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-thread-resolved": { + "title": "pull_request_review_thread resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" ] }, "url": { @@ -271436,23 +274553,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "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).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -271652,23 +274752,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_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).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -271724,11 +274807,6 @@ "type": "string", "format": "uri" }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, "visibility": { "type": "string", "enum": [ @@ -272269,23 +275347,6 @@ "master_branch": { "type": "string" }, - "merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ] - }, - "merge_commit_title": { - "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).", - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ] - }, "merges_url": { "type": "string", "format": "uri" @@ -272485,23 +275546,6 @@ "size": { "type": "integer" }, - "squash_merge_commit_message": { - "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.", - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ] - }, - "squash_merge_commit_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).", - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ] - }, "ssh_url": { "type": "string" }, @@ -272557,11 +275601,6 @@ "type": "string", "format": "uri" }, - "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "type": "boolean", - "default": false - }, "visibility": { "type": "string", "enum": [ @@ -272948,8 +275987,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -273611,35 +276649,417 @@ "repository": { "$ref": "#/components/schemas/repository-webhooks" }, - "review": { - "$ref": "#/components/schemas/webhooks_review" - }, "sender": { "$ref": "#/components/schemas/simple-user" + }, + "thread": { + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": [ + "integer", + "null" + ] + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": [ + "integer", + "null" + ] + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": [ + "integer", + "null" + ] + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": [ + "string", + "null" + ], + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + } + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "comments" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ "action", - "review", + "thread", "pull_request", - "repository", - "sender" + "repository" ], "x-github-breaking-changes": [ - { - "changeset": "remove_use_squash_pr_title_as_default", - "patch": [ - { - "op": "remove", - "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - }, - { - "op": "remove", - "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - } - ], - "version": "2026-03-10" - }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ @@ -273656,14 +277076,14 @@ } ] }, - "webhook-pull-request-review-thread-resolved": { - "title": "pull_request_review_thread resolved event", + "webhook-pull-request-review-thread-unresolved": { + "title": "pull_request_review_thread unresolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unresolved" ] }, "enterprise": { @@ -274041,10 +277461,7 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": [ - "string", - "null" - ] + "type": "string" }, "enabled_by": { "title": "User", @@ -274954,10 +278371,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -274965,10 +278379,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -276078,8 +279489,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -276227,16 +279637,7 @@ }, "required": [ "name", - "id", - "node_id", - "slug", - "description", - "privacy", - "url", - "html_url", - "members_url", - "repositories_url", - "permission" + "id" ] } ] @@ -276493,8 +279894,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -276676,10 +280076,7 @@ }, "original_line": { "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] + "type": "integer" }, "original_position": { "description": "The index of the original line in the diff to which the comment applies.", @@ -276893,8 +280290,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -276980,14 +280376,14 @@ } ] }, - "webhook-pull-request-review-thread-unresolved": { - "title": "pull_request_review_thread unresolved event", + "webhook-pull-request-stacked": { + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unresolved" + "stacked" ] }, "enterprise": { @@ -276996,11 +280392,14 @@ "installation": { "$ref": "#/components/schemas/simple-installation" }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { - "title": "Simple Pull Request", + "title": "Pull Request", "type": "object", "properties": { "_links": { @@ -277135,6 +280534,9 @@ null ] }, + "additions": { + "type": "integer" + }, "assignee": { "title": "User", "type": [ @@ -277218,7 +280620,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277319,7 +280722,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -277365,7 +280769,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -277778,6 +281185,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -277977,6 +281401,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -278032,6 +281473,11 @@ "type": "string", "format": "uri" }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, "visibility": { "type": "string", "enum": [ @@ -278247,35 +281693,53 @@ "null" ] }, + "changed_files": { + "type": "integer" + }, "closed_at": { "type": [ "string", "null" - ] + ], + "format": "date-time" + }, + "comments": { + "type": "integer" }, "comments_url": { "type": "string", "format": "uri" }, + "commits": { + "type": "integer" + }, "commits_url": { "type": "string", "format": "uri" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" }, "diff_url": { "type": "string", "format": "uri" }, "draft": { + "description": "Indicates whether or not the pull request is a draft.", "type": "boolean" }, "head": { "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -278283,7 +281747,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -278566,6 +282033,23 @@ "master_branch": { "type": "string" }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, "merges_url": { "type": "string", "format": "uri" @@ -278765,6 +282249,23 @@ "size": { "type": "integer" }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, "ssh_url": { "type": "string" }, @@ -278820,6 +282321,11 @@ "type": "string", "format": "uri" }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, "visibility": { "type": "string", "enum": [ @@ -279089,16 +282595,136 @@ "locked": { "type": "boolean" }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, "merge_commit_sha": { "type": [ "string", "null" ] }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, "merged_at": { "type": [ "string", "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "milestone": { @@ -279206,7 +282832,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -279300,12 +282927,19 @@ "type": "string" }, "number": { + "description": "Number uniquely identifying the pull request within its repository.", "type": "integer" }, "patch_url": { "type": "string", "format": "uri" }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, "requested_reviewers": { "type": "array", "items": { @@ -279393,7 +283027,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -279541,7 +283176,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -279689,11 +283333,15 @@ "type": "string", "format": "uri-template" }, + "review_comments": { + "type": "integer" + }, "review_comments_url": { "type": "string", "format": "uri" }, "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", "enum": [ "open", @@ -279705,10 +283353,12 @@ "format": "uri" }, "title": { + "description": "The title of the pull request.", "type": "string" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "url": { "type": "string", @@ -279798,7 +283448,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -279840,7 +283491,6 @@ "requested_teams", "labels", "milestone", - "draft", "commits_url", "review_comments_url", "review_comment_url", @@ -279851,7 +283501,8 @@ "_links", "author_association", "auto_merge", - "active_lock_reason" + "active_lock_reason", + "draft" ] }, "repository": { @@ -279859,411 +283510,30 @@ }, "sender": { "$ref": "#/components/schemas/simple-user" - }, - "thread": { - "type": "object", - "properties": { - "comments": { - "type": "array", - "items": { - "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - }, - "self": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "self", - "html", - "pull_request" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "The text of the comment.", - "type": "string" - }, - "commit_id": { - "description": "The SHA of the commit to which the comment applies.", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "diff_hunk": { - "description": "The diff of the line that the comment refers to.", - "type": "string" - }, - "html_url": { - "description": "HTML URL for the pull request review comment.", - "type": "string", - "format": "uri" - }, - "id": { - "description": "The ID of the pull request review comment.", - "type": "integer" - }, - "in_reply_to_id": { - "description": "The comment ID to reply to.", - "type": "integer" - }, - "line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": [ - "integer", - "null" - ] - }, - "node_id": { - "description": "The node ID of the pull request review comment.", - "type": "string" - }, - "original_commit_id": { - "description": "The SHA of the original commit to which the comment applies.", - "type": "string" - }, - "original_line": { - "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", - "type": "integer" - }, - "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", - "type": "integer" - }, - "original_start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "path": { - "description": "The relative path of the file to which the comment applies.", - "type": "string" - }, - "position": { - "description": "The line index in the diff to which the comment applies.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_review_id": { - "description": "The ID of the pull request review to which the comment belongs.", - "type": [ - "integer", - "null" - ] - }, - "pull_request_url": { - "description": "URL for the pull request that the review comment belongs to.", - "type": "string", - "format": "uri" - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": "string", - "enum": [ - "LEFT", - "RIGHT" - ] - }, - "start_line": { - "description": "The first line of the range for a multi-line comment.", - "type": [ - "integer", - "null" - ] - }, - "start_side": { - "description": "The side of the first line of the range for a multi-line comment.", - "type": [ - "string", - "null" - ], - "enum": [ - "LEFT", - "RIGHT", - null - ], - "default": "RIGHT" - }, - "subject_type": { - "description": "The level at which the comment is targeted, can be a diff line or a file.", - "type": "string", - "enum": [ - "line", - "file" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "description": "URL for the pull request review comment", - "type": "string", - "format": "uri" - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "pull_request_review_id", - "id", - "node_id", - "diff_hunk", - "path", - "position", - "original_position", - "commit_id", - "original_commit_id", - "user", - "body", - "created_at", - "updated_at", - "html_url", - "pull_request_url", - "author_association", - "_links", - "start_line", - "original_start_line", - "original_line", - "line", - "start_side", - "side", - "reactions" - ] - } - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "node_id", - "comments" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } }, "required": [ "action", - "thread", + "number", "pull_request", - "repository" + "repository", + "sender" ], "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index b136960dca..d1de414eb3 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -77544,6 +77544,72 @@ webhooks: - repository - organization - app + pull-request-stacked: + post: + summary: |- + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request was added to a stack. + operationId: pull-request/stacked + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + 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: pull_request + 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-pull-request-stacked" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app pull-request-synchronize: post: summary: |- @@ -97632,6 +97698,8 @@ components: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" require_code_owner_review: type: boolean description: Require an approving review in pull requests that modify @@ -198286,76 +198354,2361 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: - "$ref": "#/components/schemas/simple-user" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: + "$ref": "#/components/schemas/simple-user" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + - op: remove + path: "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + version: '2026-03-10' + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/oneOf/0/properties/pull_request/properties/merge_commit_sha" + - op: remove + path: "/oneOf/0/properties/pull_request/required/17" + - op: remove + path: "/oneOf/1/properties/pull_request/properties/merge_commit_sha" + - op: remove + path: "/oneOf/1/properties/pull_request/required/17" + version: '2026-03-10' + webhook-pull-request-review-submitted: + title: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: + - string + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: + "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - review + - pull_request + - repository + - sender x-github-breaking-changes: - changeset: remove_use_squash_pr_title_as_default patch: - op: remove - path: "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - op: remove - path: "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" version: '2026-03-10' - changeset: remove_pull_request_merge_commit_sha patch: - op: remove - path: "/oneOf/0/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/oneOf/0/properties/pull_request/required/17" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/merge_commit_sha" + path: "/properties/pull_request/properties/merge_commit_sha" - op: remove - path: "/oneOf/1/properties/pull_request/required/17" + path: "/properties/pull_request/required/17" version: '2026-03-10' - webhook-pull-request-review-submitted: - title: pull_request_review submitted event + webhook-pull-request-review-thread-resolved: + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -198523,7 +200876,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198597,7 +200949,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -198937,28 +201288,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -199098,28 +201427,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -199160,12 +201467,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -199581,28 +201882,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -199742,28 +202021,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -199804,12 +202061,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -200113,7 +202364,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -200608,24 +202858,324 @@ components: - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" - review: - "$ref": "#/components/schemas/webhooks_review" sender: "$ref": "#/components/schemas/simple-user" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - changeset: remove_pull_request_merge_commit_sha patch: - op: remove @@ -200633,14 +203183,14 @@ components: - op: remove path: "/properties/pull_request/required/17" version: '2026-03-10' - webhook-pull-request-review-thread-resolved: - title: pull_request_review_thread resolved event + webhook-pull-request-review-thread-unresolved: + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -200914,9 +203464,7 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -201594,17 +204142,13 @@ components: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -202433,7 +204977,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -202544,15 +205087,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -202742,7 +205276,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -202888,9 +205421,7 @@ components: original_line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -203057,7 +205588,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -203115,22 +205645,24 @@ components: - op: remove path: "/properties/pull_request/required/17" version: '2026-03-10' - webhook-pull-request-review-thread-unresolved: - title: pull_request_review_thread unresolved event + webhook-pull-request-stacked: + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -203227,6 +205759,8 @@ components: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -203290,6 +205824,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203363,6 +205898,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -203396,7 +205932,9 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -203700,6 +206238,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -203839,6 +206399,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -203879,6 +206461,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -204053,34 +206641,49 @@ components: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -204290,6 +206893,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -204429,6 +207054,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -204469,6 +207116,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property is closing down. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -204684,14 +207337,100 @@ components: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean merge_commit_sha: type: - string - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -204772,6 +207511,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -204839,10 +207579,16 @@ components: node_id: type: string number: + description: Number uniquely identifying the pull request within its + repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -204909,6 +207655,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -205019,6 +207766,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -205126,10 +207882,13 @@ components: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -205138,9 +207897,11 @@ components: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -205208,6 +207969,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -205241,7 +208003,6 @@ components: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -205253,323 +208014,25 @@ components: - author_association - auto_merge - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + - op: remove + path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + version: '2026-03-10' - changeset: remove_pull_request_merge_commit_sha patch: - op: remove diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 1f6e06d4c0..1587eabaa4 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -245483,6 +245483,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -246782,6 +246825,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -248155,6 +248241,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -250292,6 +250421,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -251616,6 +251788,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -252985,6 +253200,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -665700,6 +665958,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -667566,6 +667867,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -668732,6 +669076,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -670111,6 +670498,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -672267,6 +672697,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -673448,6 +673921,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -674823,6 +675339,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1540728,11 +1541287,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1540799,21 +1541358,15 @@ "content": { "application/json": { "schema": { - "title": "pull_request synchronize event", + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "synchronize" + "stacked" ] }, - "after": { - "type": "string" - }, - "before": { - "type": "string" - }, "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/admin/overview/about-enterprise-accounts).\"", @@ -1542370,7 +1542923,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1542378,7 +1542934,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1542662,7 +1543221,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "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.", "type": "string", "enum": [ "PR_BODY", @@ -1542671,7 +1543230,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "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).", "type": "string", "enum": [ "PR_TITLE", @@ -1543338,7 +1543897,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1545809,8 +1546369,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1545836,11 +1546394,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1545907,114 +1546465,20 @@ "content": { "application/json": { "schema": { - "title": "pull_request unassigned event", + "title": "pull_request synchronize event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unassigned" + "synchronize" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1546730,10 +1547194,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1547575,10 +1548036,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1547586,10 +1548044,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1547873,7 +1548328,7 @@ "type": "string" }, "merge_commit_message": { - "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.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1547882,7 +1548337,7 @@ ] }, "merge_commit_title": { - "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).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1548549,8 +1549004,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1551021,8 +1551475,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ] } } @@ -1551045,11 +1551502,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1551116,13 +1551573,113 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlabeled event", + "title": "pull_request unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "unassigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1551240,49 +1551797,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1551882,7 +1552396,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1553022,7 +1553539,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "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.", "type": "string", "enum": [ "PR_BODY", @@ -1553031,7 +1553548,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "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).", "type": "string", "enum": [ "PR_TITLE", @@ -1553698,7 +1554215,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1556170,8 +1556688,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -1556194,11 +1556711,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1556265,13 +1556782,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlocked event", + "title": "pull_request unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "unlabeled" ] }, "enterprise": { @@ -1556389,6 +1556906,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1556714,7 +1557274,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1556815,7 +1557376,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1556861,7 +1557423,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -1557825,7 +1558390,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1558120,7 +1558688,7 @@ "type": "string" }, "merge_commit_message": { - "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.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1558129,7 +1558697,7 @@ ] }, "merge_commit_title": { - "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).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1558917,7 +1559485,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1559111,7 +1559680,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1559259,7 +1559829,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1559522,7 +1560101,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1561280,12 +1561860,5098 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "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": "pull_request", + "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": "pull_request unlocked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unlocked" + ] + }, + "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/admin/overview/about-enterprise-accounts).\"", + "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/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" + ] + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "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" + ] + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string" + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "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", + "format": "int64", + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "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 is closing down. 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" + ] + }, + "sender": { + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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", + "number", + "pull_request", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "push": { + "post": { + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1613741,6 +1619407,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1617074,6 +1622783,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1620407,6 +1626159,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1621497,6 +1627292,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1622415,6 +1628253,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1623336,6 +1629217,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index c89d88774f..3d65da0c15 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -51602,6 +51602,43 @@ paths: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps + allowed to dismiss pull request reviews. + items: + title: Actor + description: An actor allowed to dismiss pull + request reviews + type: object + properties: + id: + type: integer + description: ID of the actor that can + dismiss reviews. + type: + type: string + description: The type of the actor + enum: + - User + - Team + - IntegrationInstallation + - RepositoryRole + required: + - id + - type + enabled: + type: boolean + description: Whether to restrict review dismissal + to specific actors. + required: + - enabled require_code_owner_review: type: boolean description: Require an approving review in pull @@ -215650,44 +215687,2385 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: *4 - required: - - requested_team - - action - - number - - pull_request - - repository - - sender + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: *4 + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app + pull-request-review-submitted: + post: + summary: |- + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A review on a pull request was submitted. + operationId: pull-request-review/submitted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + 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: pull_request_review + 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: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: *745 + installation: *746 + organization: *747 + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: + - string + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have + for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: *748 + review: *795 + sender: *4 + required: + - action + - review + - pull_request + - repository + - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -215695,23 +218073,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-submitted: + pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -215725,7 +218103,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review + example: pull_request_review_thread schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -215753,13 +218131,13 @@ webhooks: content: application/json: schema: - title: pull_request_review submitted event + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: *745 installation: *746 organization: *747 @@ -215924,7 +218302,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -215998,7 +218375,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -216342,28 +218718,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -216503,28 +218857,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -216565,13 +218897,6 @@ webhooks: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false visibility: type: string enum: @@ -216991,28 +219316,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -217152,28 +219455,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -217214,13 +219495,6 @@ webhooks: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false visibility: type: string enum: @@ -217524,7 +219798,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -218021,14 +220294,329 @@ webhooks: - auto_merge - active_lock_reason repository: *748 - review: *795 sender: *4 + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment + applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers + to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the + comment applies. + type: string + original_line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff + to which the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the + comment applies. + type: string + position: + description: The line index in the diff to which the comment + applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which + the comment belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review + comment belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for + a multi-line comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for + a multi-line comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, + can be a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -218036,12 +220624,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - pull-request-review-thread-resolved: + pull-request-review-thread-unresolved: post: summary: |- This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. @@ -218049,8 +220637,9 @@ webhooks: For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: @@ -218094,13 +220683,13 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread resolved event + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: *745 installation: *746 organization: *747 @@ -218371,9 +220960,7 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -219055,17 +221642,13 @@ webhooks: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -219898,7 +222481,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -220010,15 +222592,6 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -220210,7 +222783,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -220358,9 +222930,7 @@ webhooks: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -220530,7 +223100,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -220592,19 +223161,18 @@ webhooks: - repository - organization - app - pull-request-review-thread-unresolved: + pull-request-stacked: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved + description: A pull request was added to a stack. + operationId: pull-request/stacked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -220618,7 +223186,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review_thread + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -220646,18 +223214,19 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread unresolved event + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: *745 installation: *746 + number: *790 organization: *747 pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -220754,6 +223323,8 @@ webhooks: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -220817,6 +223388,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -220890,6 +223462,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -220923,7 +223496,9 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -221231,6 +223806,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -221370,6 +223967,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -221410,6 +224029,13 @@ webhooks: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false visibility: type: string enum: @@ -221584,34 +224210,50 @@ webhooks: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a + draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -221825,6 +224467,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -221964,6 +224628,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -222004,6 +224690,13 @@ webhooks: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false visibility: type: string enum: @@ -222219,14 +224912,101 @@ webhooks: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean merge_commit_sha: type: - string - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -222307,6 +225087,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -222374,10 +225155,16 @@ webhooks: node_id: type: string number: + description: Number uniquely identifying the pull request within + its repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -222444,6 +225231,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -222555,6 +225343,15 @@ webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -222664,10 +225461,13 @@ webhooks: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -222676,9 +225476,11 @@ webhooks: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -222746,6 +225548,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -222779,7 +225582,6 @@ webhooks: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -222791,327 +225593,15 @@ webhooks: - author_association - auto_merge - active_lock_reason + - draft repository: *748 sender: *4 - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment - applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers - to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the - comment applies. - type: string - original_line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: integer - original_position: - description: The index of the original line in the diff - to which the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the - comment applies. - type: string - position: - description: The line index in the diff to which the comment - applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which - the comment belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review - comment belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for - a multi-line comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for - a multi-line comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, - can be a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -223119,7 +225609,7 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 9e7d568e42..2682f53005 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -238099,6 +238099,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -239398,6 +239441,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -240771,6 +240857,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -242908,6 +243037,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -244232,6 +244404,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -245601,6 +245816,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -652092,6 +652350,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -653958,6 +654259,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -655124,6 +655468,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -656503,6 +656890,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -658659,6 +659089,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -659840,6 +660313,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -661215,6 +661731,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1515797,11 +1516356,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1515868,21 +1516427,15 @@ "content": { "application/json": { "schema": { - "title": "pull_request synchronize event", + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "synchronize" + "stacked" ] }, - "after": { - "type": "string" - }, - "before": { - "type": "string" - }, "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/admin/overview/about-enterprise-accounts).\"", @@ -1517434,7 +1517987,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1517442,7 +1517998,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1517726,7 +1518285,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "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.", "type": "string", "enum": [ "PR_BODY", @@ -1517735,7 +1518294,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "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).", "type": "string", "enum": [ "PR_TITLE", @@ -1518391,7 +1518950,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1520849,8 +1521409,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1520876,11 +1521434,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1520947,114 +1521505,20 @@ "content": { "application/json": { "schema": { - "title": "pull_request unassigned event", + "title": "pull_request synchronize event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unassigned" + "synchronize" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1521770,10 +1522234,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1522610,10 +1523071,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1522621,10 +1523079,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1522908,7 +1523363,7 @@ "type": "string" }, "merge_commit_message": { - "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.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1522917,7 +1523372,7 @@ ] }, "merge_commit_title": { - "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).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1523573,8 +1524028,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1526032,8 +1526486,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ] } } @@ -1526056,11 +1526513,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1526127,13 +1526584,113 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlabeled event", + "title": "pull_request unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "unassigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1526251,49 +1526808,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1526893,7 +1527407,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1528028,7 +1528545,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "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.", "type": "string", "enum": [ "PR_BODY", @@ -1528037,7 +1528554,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "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).", "type": "string", "enum": [ "PR_TITLE", @@ -1528693,7 +1529210,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1531152,8 +1531670,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -1531176,11 +1531693,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1531247,13 +1531764,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlocked event", + "title": "pull_request unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "unlabeled" ] }, "enterprise": { @@ -1531371,6 +1531888,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1531696,7 +1532256,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1531797,7 +1532358,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1531843,7 +1532405,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -1532802,7 +1533367,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1533097,7 +1533665,7 @@ "type": "string" }, "merge_commit_message": { - "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.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1533106,7 +1533674,7 @@ ] }, "merge_commit_title": { - "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).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1533883,7 +1534451,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1534077,7 +1534646,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1534225,7 +1534795,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1534488,7 +1535067,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1536233,12 +1536813,5069 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "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": "pull_request", + "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": "pull_request unlocked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unlocked" + ] + }, + "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/admin/overview/about-enterprise-accounts).\"", + "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/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" + ] + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "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" + ] + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string" + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "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", + "format": "int64", + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "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" + }, + "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 + ] + }, + "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" + }, + "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" + ] + }, + "sender": { + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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", + "number", + "pull_request", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "push": { + "post": { + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1588382,6 +1594019,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1591703,6 +1597383,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1595024,6 +1600747,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1596114,6 +1601880,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1597032,6 +1602841,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1597953,6 +1603805,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 044537eed3..fd748e326b 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -51224,6 +51224,43 @@ paths: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps + allowed to dismiss pull request reviews. + items: + title: Actor + description: An actor allowed to dismiss pull + request reviews + type: object + properties: + id: + type: integer + description: ID of the actor that can + dismiss reviews. + type: + type: string + description: The type of the actor + enum: + - User + - Team + - IntegrationInstallation + - RepositoryRole + required: + - id + - type + enabled: + type: boolean + description: Whether to restrict review dismissal + to specific actors. + required: + - enabled require_code_owner_review: type: boolean description: Require an approving review in pull @@ -214951,44 +214988,2366 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: *4 - required: - - requested_team - - action - - number - - pull_request - - repository - - sender + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: *4 + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app + pull-request-review-submitted: + post: + summary: |- + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A review on a pull request was submitted. + operationId: pull-request-review/submitted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + 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: pull_request_review + 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: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: *745 + installation: *746 + organization: *747 + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have + for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: *748 + review: *795 + sender: *4 + required: + - action + - review + - pull_request + - repository + - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -214996,23 +217355,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-submitted: + pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -215026,7 +217385,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review + example: pull_request_review_thread schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -215054,13 +217413,13 @@ webhooks: content: application/json: schema: - title: pull_request_review submitted event + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: *745 installation: *746 organization: *747 @@ -215225,7 +217584,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -215299,7 +217657,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -215643,28 +218000,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -215804,28 +218139,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -216285,28 +218598,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -216446,28 +218737,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -216807,7 +219076,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -217303,14 +219571,329 @@ webhooks: - auto_merge - active_lock_reason repository: *748 - review: *795 sender: *4 + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment + applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers + to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the + comment applies. + type: string + original_line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff + to which the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the + comment applies. + type: string + position: + description: The line index in the diff to which the comment + applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which + the comment belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review + comment belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for + a multi-line comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for + a multi-line comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, + can be a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -217318,12 +219901,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - pull-request-review-thread-resolved: + pull-request-review-thread-unresolved: post: summary: |- This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. @@ -217331,8 +219914,9 @@ webhooks: For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: @@ -217376,13 +219960,13 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread resolved event + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: *745 installation: *746 organization: *747 @@ -217653,9 +220237,7 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -218337,17 +220919,13 @@ webhooks: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -219176,7 +221754,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -219288,15 +221865,6 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -219488,7 +222056,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -219635,9 +222202,7 @@ webhooks: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -219807,7 +222372,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -219869,19 +222433,18 @@ webhooks: - repository - organization - app - pull-request-review-thread-unresolved: + pull-request-stacked: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved + description: A pull request was added to a stack. + operationId: pull-request/stacked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -219895,7 +222458,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review_thread + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -219923,18 +222486,19 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread unresolved event + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: *745 installation: *746 + number: *790 organization: *747 pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -220031,6 +222595,8 @@ webhooks: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -220094,6 +222660,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -220167,6 +222734,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -220200,7 +222768,9 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -220508,6 +223078,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -220647,6 +223239,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -220861,34 +223475,50 @@ webhooks: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a + draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -221102,6 +223732,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -221241,6 +223893,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -221496,10 +224170,97 @@ webhooks: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -221580,6 +224341,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -221647,10 +224409,16 @@ webhooks: node_id: type: string number: + description: Number uniquely identifying the pull request within + its repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -221717,6 +224485,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -221828,6 +224597,15 @@ webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -221937,10 +224715,13 @@ webhooks: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -221949,9 +224730,11 @@ webhooks: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -222019,6 +224802,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -222051,7 +224835,6 @@ webhooks: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -222063,327 +224846,15 @@ webhooks: - author_association - auto_merge - active_lock_reason + - draft repository: *748 sender: *4 - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment - applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers - to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the - comment applies. - type: string - original_line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: integer - original_position: - description: The index of the original line in the diff - to which the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the - comment applies. - type: string - position: - description: The line index in the diff to which the comment - applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which - the comment belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review - comment belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for - a multi-line comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for - a multi-line comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, - can be a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -222391,7 +224862,7 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 94e8e35a26..02db3d277b 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -252389,6 +252389,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -253688,6 +253731,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -255061,6 +255147,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -257198,6 +257327,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -258522,6 +258694,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -259891,6 +260106,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -680078,6 +680336,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -681944,6 +682245,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -683110,6 +683454,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -684489,6 +684876,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -686645,6 +687075,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -687826,6 +688299,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -689201,6 +689717,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1572387,11 +1572946,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1572458,21 +1573017,15 @@ "content": { "application/json": { "schema": { - "title": "pull_request synchronize event", + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "synchronize" + "stacked" ] }, - "after": { - "type": "string" - }, - "before": { - "type": "string" - }, "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/admin/overview/about-enterprise-accounts).\"", @@ -1574029,7 +1574582,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1574037,7 +1574593,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1574321,7 +1574880,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "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.", "type": "string", "enum": [ "PR_BODY", @@ -1574330,7 +1574889,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "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).", "type": "string", "enum": [ "PR_TITLE", @@ -1574997,7 +1575556,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1577493,8 +1578053,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1577550,11 +1578108,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1577621,114 +1578179,20 @@ "content": { "application/json": { "schema": { - "title": "pull_request unassigned event", + "title": "pull_request synchronize event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unassigned" + "synchronize" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1578444,10 +1578908,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1579289,10 +1579750,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1579300,10 +1579758,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1579587,7 +1580042,7 @@ "type": "string" }, "merge_commit_message": { - "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.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1579596,7 +1580051,7 @@ ] }, "merge_commit_title": { - "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).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1580263,8 +1580718,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1582760,8 +1583214,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ], "x-github-breaking-changes": [ { @@ -1582814,11 +1583271,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1582885,13 +1583342,113 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlabeled event", + "title": "pull_request unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "unassigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1583009,49 +1583566,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1583651,7 +1584165,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1584791,7 +1585308,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "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.", "type": "string", "enum": [ "PR_BODY", @@ -1584800,7 +1585317,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "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).", "type": "string", "enum": [ "PR_TITLE", @@ -1585467,7 +1585984,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1587964,8 +1588482,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ], "x-github-breaking-changes": [ { @@ -1588018,11 +1588535,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1588089,13 +1588606,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlocked event", + "title": "pull_request unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "unlabeled" ] }, "enterprise": { @@ -1588213,6 +1588730,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1588538,7 +1589098,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1588639,7 +1589200,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1588685,7 +1589247,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -1589649,7 +1590214,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1589944,7 +1590512,7 @@ "type": "string" }, "merge_commit_message": { - "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.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1589953,7 +1590521,7 @@ ] }, "merge_commit_title": { - "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).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1590741,7 +1591309,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1590935,7 +1591504,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1591083,7 +1591653,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1591346,7 +1591925,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1593159,12 +1593739,5153 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "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": "pull_request", + "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": "pull_request unlocked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unlocked" + ] + }, + "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/admin/overview/about-enterprise-accounts).\"", + "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/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" + ] + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "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" + ] + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string" + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "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", + "format": "int64", + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "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 is closing down. 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" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null, + "template_repository": { + "properties": { + "use_squash_pr_title_as_default": null + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + } + ] + }, + "sender": { + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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", + "number", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "push": { + "post": { + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -1646221,6 +1651942,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1649579,6 +1655343,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1652937,6 +1658744,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1654027,6 +1659877,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1654945,6 +1660838,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1655866,6 +1661802,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 02ef7d0b39..929323152c 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -52068,6 +52068,43 @@ paths: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps + allowed to dismiss pull request reviews. + items: + title: Actor + description: An actor allowed to dismiss pull + request reviews + type: object + properties: + id: + type: integer + description: ID of the actor that can + dismiss reviews. + type: + type: string + description: The type of the actor + enum: + - User + - Team + - IntegrationInstallation + - RepositoryRole + required: + - id + - type + enabled: + type: boolean + description: Whether to restrict review dismissal + to specific actors. + required: + - enabled require_code_owner_review: type: boolean description: Require an approving review in pull @@ -216839,66 +216876,2422 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: *4 - required: - - requested_team - - action - - number - - pull_request - - repository - - sender + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: *4 + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + - op: remove + path: "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + version: '2026-03-10' + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/oneOf/0/properties/pull_request/properties/merge_commit_sha" + - op: remove + path: "/oneOf/0/properties/pull_request/required/17" + - op: remove + path: "/oneOf/1/properties/pull_request/properties/merge_commit_sha" + - op: remove + path: "/oneOf/1/properties/pull_request/required/17" + version: '2026-03-10' + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app + pull-request-review-submitted: + post: + summary: |- + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A review on a pull request was submitted. + operationId: pull-request-review/submitted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + 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: pull_request_review + 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: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: *745 + installation: *746 + organization: *747 + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: + - string + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have + for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: *748 + review: *795 + sender: *4 + required: + - action + - review + - pull_request + - repository + - sender x-github-breaking-changes: - changeset: remove_use_squash_pr_title_as_default patch: - op: remove - path: "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - op: remove - path: "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" version: '2026-03-10' - changeset: remove_pull_request_merge_commit_sha patch: - op: remove - path: "/oneOf/0/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/oneOf/0/properties/pull_request/required/17" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/merge_commit_sha" + path: "/properties/pull_request/properties/merge_commit_sha" - op: remove - path: "/oneOf/1/properties/pull_request/required/17" + path: "/properties/pull_request/required/17" version: '2026-03-10' responses: '200': @@ -216907,23 +219300,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-submitted: + pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -216937,7 +219330,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review + example: pull_request_review_thread schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -216965,13 +219358,13 @@ webhooks: content: application/json: schema: - title: pull_request_review submitted event + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: *745 installation: *746 organization: *747 @@ -217136,7 +219529,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -217210,7 +219602,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -217554,28 +219945,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -217715,28 +220084,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -217777,13 +220124,6 @@ webhooks: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false visibility: type: string enum: @@ -218203,28 +220543,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -218364,28 +220682,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -218426,13 +220722,6 @@ webhooks: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false visibility: type: string enum: @@ -218736,7 +221025,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -219233,22 +221521,330 @@ webhooks: - auto_merge - active_lock_reason repository: *748 - review: *795 sender: *4 + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment + applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers + to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the + comment applies. + type: string + original_line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff + to which the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the + comment applies. + type: string + position: + description: The line index in the diff to which the comment + applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which + the comment belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review + comment belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for + a multi-line comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for + a multi-line comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, + can be a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - changeset: remove_pull_request_merge_commit_sha patch: - op: remove @@ -219263,12 +221859,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - pull-request-review-thread-resolved: + pull-request-review-thread-unresolved: post: summary: |- This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. @@ -219276,8 +221872,9 @@ webhooks: For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: @@ -219321,13 +221918,13 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread resolved event + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: *745 installation: *746 organization: *747 @@ -219598,9 +222195,7 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -220282,17 +222877,13 @@ webhooks: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -221125,7 +223716,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -221237,15 +223827,6 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -221437,7 +224018,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -221585,9 +224165,7 @@ webhooks: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -221757,7 +224335,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -221827,19 +224404,18 @@ webhooks: - repository - organization - app - pull-request-review-thread-unresolved: + pull-request-stacked: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved + description: A pull request was added to a stack. + operationId: pull-request/stacked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -221853,7 +224429,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review_thread + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -221881,18 +224457,19 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread unresolved event + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: *745 installation: *746 + number: *790 organization: *747 pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -221989,6 +224566,8 @@ webhooks: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -222052,6 +224631,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -222125,6 +224705,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -222158,7 +224739,9 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -222466,6 +225049,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -222605,6 +225210,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -222645,6 +225272,13 @@ webhooks: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false visibility: type: string enum: @@ -222819,34 +225453,50 @@ webhooks: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a + draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -223060,6 +225710,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -223199,6 +225871,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -223239,6 +225933,13 @@ webhooks: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false visibility: type: string enum: @@ -223454,14 +226155,101 @@ webhooks: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean merge_commit_sha: type: - string - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -223542,6 +226330,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -223609,10 +226398,16 @@ webhooks: node_id: type: string number: + description: Number uniquely identifying the pull request within + its repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -223679,6 +226474,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -223790,6 +226586,15 @@ webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -223899,10 +226704,13 @@ webhooks: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -223911,9 +226719,11 @@ webhooks: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -223981,6 +226791,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -224014,7 +226825,6 @@ webhooks: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -224026,328 +226836,23 @@ webhooks: - author_association - auto_merge - active_lock_reason + - draft repository: *748 sender: *4 - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment - applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers - to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the - comment applies. - type: string - original_line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: integer - original_position: - description: The index of the original line in the diff - to which the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the - comment applies. - type: string - position: - description: The line index in the diff to which the comment - applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which - the comment belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review - comment belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for - a multi-line comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for - a multi-line comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, - can be a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: - - string - - 'null' - format: date-time required: - action - - thread + - number - pull_request - repository + - sender x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + - op: remove + path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + - op: remove + path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + version: '2026-03-10' - changeset: remove_pull_request_merge_commit_sha patch: - op: remove @@ -224362,7 +226867,7 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization 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 4f4bb3037a..3f761c0c79 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -59526,115 +59526,123 @@ "content": { "application/json": { "schema": { - "type": "array", - "description": "Array of vulnerabilities in OSV format to synchronize", - "items": { - "title": "OSV Vulnerability", - "description": "A vulnerability in OSV (Open Source Vulnerability) format", - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the vulnerability from the external system", - "examples": [ - "MVS-2026-001" - ] - }, - "schema_version": { - "type": "string", - "description": "The OSV schema version", - "examples": [ - "1.4.0" - ] - }, - "summary": { - "type": "string", - "description": "A short summary of the vulnerability", - "examples": [ - "Example vulnerability summary" - ] - }, - "details": { - "type": "string", - "description": "Detailed description of the vulnerability" - }, - "aliases": { - "type": "array", - "description": "IDs for the same vulnerability in other databases. Only CVE IDs are used (to populate the vulnerability's CVE identifier); other aliases are ignored.", - "items": { - "type": "string" - }, - "examples": [ - "CVE-2026-12345" - ] - }, - "severity": { - "type": "array", - "description": "Severity information for the vulnerability", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of severity scoring (e.g., CVSS_V3)" + "type": "object", + "required": [ + "vulnerabilities" + ], + "properties": { + "vulnerabilities": { + "type": "array", + "description": "Array of vulnerabilities in OSV format to synchronize", + "items": { + "title": "OSV Vulnerability", + "description": "A vulnerability in OSV (Open Source Vulnerability) format", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the vulnerability from the external system", + "examples": [ + "MVS-2026-001" + ] + }, + "schema_version": { + "type": "string", + "description": "The OSV schema version", + "examples": [ + "1.4.0" + ] + }, + "summary": { + "type": "string", + "description": "A short summary of the vulnerability", + "examples": [ + "Example vulnerability summary" + ] + }, + "details": { + "type": "string", + "description": "Detailed description of the vulnerability" + }, + "aliases": { + "type": "array", + "description": "IDs for the same vulnerability in other databases. Only CVE IDs are used (to populate the vulnerability's CVE identifier); other aliases are ignored.", + "items": { + "type": "string" }, - "score": { - "type": "string", - "description": "The severity score or vector string" - } - } - } - }, - "affected": { - "type": "array", - "description": "Packages and versions affected by the vulnerability", - "items": { - "type": "object", - "properties": { - "package": { + "examples": [ + "CVE-2026-12345" + ] + }, + "severity": { + "type": "array", + "description": "Severity information for the vulnerability", + "items": { "type": "object", "properties": { - "ecosystem": { + "type": { "type": "string", - "description": "The package ecosystem (e.g., npm, pip, maven)" + "description": "The type of severity scoring (e.g., CVSS_V3)" }, - "name": { + "score": { "type": "string", - "description": "The package name" + "description": "The severity score or vector string" } } - }, - "ranges": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "object", - "properties": { - "introduced": { - "type": "string", - "description": "The version that introduced the vulnerability" - }, - "fixed": { - "type": "string", - "description": "The version that fixed the vulnerability" - }, - "last_affected": { - "type": "string", - "description": "The last affected version" - }, - "limit": { - "type": "string", - "description": "The upper limit of the affected range" + } + }, + "affected": { + "type": "array", + "description": "Packages and versions affected by the vulnerability", + "items": { + "type": "object", + "properties": { + "package": { + "type": "object", + "properties": { + "ecosystem": { + "type": "string", + "description": "The package ecosystem (e.g., npm, pip, maven)" + }, + "name": { + "type": "string", + "description": "The package name" + } + } + }, + "ranges": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "introduced": { + "type": "string", + "description": "The version that introduced the vulnerability" + }, + "fixed": { + "type": "string", + "description": "The version that fixed the vulnerability" + }, + "last_affected": { + "type": "string", + "description": "The last affected version" + }, + "limit": { + "type": "string", + "description": "The upper limit of the affected range" + } + } } } } @@ -59642,80 +59650,82 @@ } } } - } - } - }, - "references": { - "type": "array", - "description": "URLs for more information about the vulnerability", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of reference. Supported values: PACKAGE, ADVISORY, WEB, FIX, ARTICLE, REPORT, EVIDENCE. References with other types are ignored." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The reference URL" + }, + "references": { + "type": "array", + "description": "URLs for more information about the vulnerability", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reference. Supported values: PACKAGE, ADVISORY, WEB, FIX, ARTICLE, REPORT, EVIDENCE. References with other types are ignored." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The reference URL" + } + } } + }, + "published": { + "type": "string", + "format": "date-time", + "description": "When the vulnerability was first published" + }, + "modified": { + "type": "string", + "format": "date-time", + "description": "When the vulnerability was last modified" + }, + "withdrawn": { + "type": "string", + "format": "date-time", + "description": "When the vulnerability was withdrawn. If present, the vulnerability will be marked as withdrawn." } } }, - "published": { - "type": "string", - "format": "date-time", - "description": "When the vulnerability was first published" - }, - "modified": { - "type": "string", - "format": "date-time", - "description": "When the vulnerability was last modified" - }, - "withdrawn": { - "type": "string", - "format": "date-time", - "description": "When the vulnerability was withdrawn. If present, the vulnerability will be marked as withdrawn." - } + "minItems": 1, + "maxItems": 100 } - }, - "minItems": 1, - "maxItems": 100 + } }, "examples": { "default": { - "value": [ - { - "id": "MVS-2026-001", - "schema_version": "1.4.0", - "summary": "Example vulnerability summary", - "aliases": [ - "GHSA-xxxx-xxxx-xxxx" - ], - "affected": [ - { - "package": { - "ecosystem": "npm", - "name": "example-package" - }, - "ranges": [ - { - "type": "SEMVER", - "events": [ - { - "introduced": "1.0.0" - }, - { - "fixed": "1.0.1" - } - ] - } - ] - } - ] - } - ] + "value": { + "vulnerabilities": [ + { + "id": "MVS-2026-001", + "schema_version": "1.4.0", + "summary": "Example vulnerability summary", + "aliases": [ + "GHSA-xxxx-xxxx-xxxx" + ], + "affected": [ + { + "package": { + "ecosystem": "npm", + "name": "example-package" + }, + "ranges": [ + { + "type": "SEMVER", + "events": [ + { + "introduced": "1.0.0" + }, + { + "fixed": "1.0.1" + } + ] + } + ] + } + ] + } + ] + } } } } @@ -67804,6 +67814,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -69164,6 +69217,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -70646,6 +70742,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -72497,6 +72636,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -73853,6 +74035,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -304668,6 +304893,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -305969,6 +306237,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -307344,6 +307655,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -309483,6 +309837,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -310809,6 +311206,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -312180,6 +312620,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -731490,6 +731973,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -733358,6 +733884,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -734526,6 +735095,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -735907,6 +736519,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -738065,6 +738720,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -739248,6 +739946,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -740625,6 +741366,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1668877,11 +1669661,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-stacked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A pull request was added to a stack.", + "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1668948,21 +1669732,15 @@ "content": { "application/json": { "schema": { - "title": "pull_request synchronize event", + "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "synchronize" + "stacked" ] }, - "after": { - "type": "string" - }, - "before": { - "type": "string" - }, "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).\"", @@ -1670519,7 +1671297,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1670527,7 +1671308,10 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1670811,7 +1671595,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "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.", "type": "string", "enum": [ "PR_BODY", @@ -1670820,7 +1671604,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "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).", "type": "string", "enum": [ "PR_TITLE", @@ -1671487,7 +1672271,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1673958,8 +1674743,6 @@ "required": [ "action", "number", - "before", - "after", "pull_request", "repository", "sender" @@ -1673985,11 +1674768,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1674056,114 +1674839,20 @@ "content": { "application/json": { "schema": { - "title": "pull_request unassigned event", + "title": "pull_request synchronize event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unassigned" + "synchronize" ] }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "after": { + "type": "string" + }, + "before": { + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -1674879,10 +1675568,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1675724,10 +1676410,7 @@ "type": "object", "properties": { "label": { - "type": [ - "string", - "null" - ] + "type": "string" }, "ref": { "type": "string" @@ -1675735,10 +1676418,7 @@ "repo": { "title": "Repository", "description": "A git repository", - "type": [ - "object", - "null" - ], + "type": "object", "properties": { "allow_auto_merge": { "description": "Whether to allow auto-merge for pull requests.", @@ -1676022,7 +1676702,7 @@ "type": "string" }, "merge_commit_message": { - "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.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1676031,7 +1676711,7 @@ ] }, "merge_commit_title": { - "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).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1676698,8 +1677378,7 @@ "enum": [ "Bot", "User", - "Organization", - "Mannequin" + "Organization" ] }, "url": { @@ -1679170,8 +1679849,11 @@ "required": [ "action", "number", + "before", + "after", "pull_request", - "repository" + "repository", + "sender" ] } } @@ -1679194,11 +1679876,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-unassigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1679265,13 +1679947,113 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlabeled event", + "title": "pull_request unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlabeled" + "unassigned" + ] + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" ] }, "enterprise": { @@ -1679389,49 +1680171,6 @@ "node_id" ] }, - "label": { - "title": "Label", - "type": "object", - "properties": { - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "id": { - "type": "integer" - }, - "name": { - "description": "The name of the label.", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the label", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "color", - "default", - "description" - ] - }, "number": { "description": "The pull request number.", "type": "integer" @@ -1680031,7 +1680770,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1681171,7 +1681913,7 @@ "type": "string" }, "merge_commit_message": { - "description": "The default value for a merge commit message.", + "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.", "type": "string", "enum": [ "PR_BODY", @@ -1681180,7 +1681922,7 @@ ] }, "merge_commit_title": { - "description": "The default value for a merge commit message title.", + "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).", "type": "string", "enum": [ "PR_TITLE", @@ -1681847,7 +1682589,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1684319,8 +1685062,7 @@ "action", "number", "pull_request", - "repository", - "sender" + "repository" ] } } @@ -1684343,11 +1685085,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, @@ -1684414,13 +1685156,13 @@ "content": { "application/json": { "schema": { - "title": "pull_request unlocked event", + "title": "pull_request unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unlocked" + "unlabeled" ] }, "enterprise": { @@ -1684538,6 +1685280,49 @@ "node_id" ] }, + "label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, "number": { "description": "The pull request number.", "type": "integer" @@ -1684863,7 +1685648,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1684964,7 +1685750,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1685010,7 +1685797,10 @@ }, "commit_title": { "description": "Title for the merge commit message.", - "type": "string" + "type": [ + "string", + "null" + ] }, "enabled_by": { "title": "User", @@ -1685974,7 +1686764,10 @@ "type": "object", "properties": { "label": { - "type": "string" + "type": [ + "string", + "null" + ] }, "ref": { "type": "string" @@ -1686269,7 +1687062,7 @@ "type": "string" }, "merge_commit_message": { - "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.", + "description": "The default value for a merge commit message.", "type": "string", "enum": [ "PR_BODY", @@ -1686278,7 +1687071,7 @@ ] }, "merge_commit_title": { - "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).", + "description": "The default value for a merge commit message title.", "type": "string", "enum": [ "PR_TITLE", @@ -1687066,7 +1687859,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1687260,7 +1688054,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1687408,7 +1688203,16 @@ }, "required": [ "name", - "id" + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" ] } ] @@ -1687671,7 +1688475,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1689429,12 +1690234,13 @@ } } }, - "push": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -1689456,7 +1690262,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "push", + "example": "pull_request", "schema": { "type": "string" } @@ -1689499,158 +1690305,15 @@ "content": { "application/json": { "schema": { - "title": "push event", + "title": "pull_request unlocked event", "type": "object", "properties": { - "after": { - "description": "The SHA of the most recent commit on `ref` after the push.", - "type": "string" - }, - "base_ref": { - "type": [ - "string", - "null" + "action": { + "type": "string", + "enum": [ + "unlocked" ] }, - "before": { - "description": "The SHA of the most recent commit on `ref` before the push.", - "type": "string" - }, - "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest/rest/commits) to fetch additional commits.", - "type": "array", - "items": { - "title": "Commit", - "type": "object", - "properties": { - "added": { - "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - } - }, - "compare": { - "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", - "type": "string" - }, - "created": { - "description": "Whether this push created the `ref`.", - "type": "boolean" - }, - "deleted": { - "description": "Whether this push deleted the `ref`.", - "type": "boolean" - }, "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).\"", @@ -1689741,132 +1690404,5360 @@ "avatar_url" ] }, - "forced": { - "description": "Whether this push was a force push of the `ref`.", - "type": "boolean" - }, - "head_commit": { - "title": "Commit", - "type": [ - "object", - "null" - ], - "properties": { - "added": { - "description": "An array of files added in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "author": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "committer": { - "title": "Committer", - "description": "Metaproperties for Git author/committer information.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "email": { - "type": [ - "string", - "null" - ], - "format": "email" - }, - "name": { - "description": "The git author's name.", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "email", - "name" - ] - }, - "distinct": { - "description": "Whether this commit is distinct from any that have been pushed before.", - "type": "boolean" - }, - "id": { - "type": "string" - }, - "message": { - "description": "The commit message.", - "type": "string" - }, - "modified": { - "description": "An array of files modified by the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "removed": { - "description": "An array of files removed in the commit.", - "type": "array", - "items": { - "type": "string" - } - }, - "timestamp": { - "description": "The ISO 8601 timestamp of the commit.", - "type": "string", - "format": "date-time" - }, - "tree_id": { - "type": "string" - }, - "url": { - "description": "URL that points to the commit API resource.", - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "tree_id", - "distinct", - "message", - "timestamp", - "url", - "author", - "committer" - ] - }, + "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" + ] + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "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" + ] + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ], + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": [ + "string", + "null" + ] + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string" + }, + "enabled_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": [ + "object", + "null" + ], + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "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).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ], + "type": [ + "null", + "integer", + "string" + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": [ + "string", + "null" + ] + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "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.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_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).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": [ + "string", + "null" + ] + }, + "mergeable": { + "type": [ + "boolean", + "null" + ] + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": [ + "boolean", + "null" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": [ + "object", + "null" + ], + "properties": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": [ + "boolean", + "null" + ] + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": [ + "object", + "null" + ], + "properties": { + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "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", + "format": "int64", + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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 + ] + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "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 is closing down. 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" + ] + }, + "sender": { + "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", + "format": "int64", + "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\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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", + "number", + "pull_request", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "push": { + "post": { + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#push" + }, + "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": "push", + "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": "push event", + "type": "object", + "properties": { + "after": { + "description": "The SHA of the most recent commit on `ref` after the push.", + "type": "string" + }, + "base_ref": { + "type": [ + "string", + "null" + ] + }, + "before": { + "description": "The SHA of the most recent commit on `ref` before the push.", + "type": "string" + }, + "commits": { + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-cloud@latest/rest/commits) to fetch additional commits.", + "type": "array", + "items": { + "title": "Commit", + "type": "object", + "properties": { + "added": { + "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + } + }, + "compare": { + "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", + "type": "string" + }, + "created": { + "description": "Whether this push created the `ref`.", + "type": "boolean" + }, + "deleted": { + "description": "Whether this push deleted the `ref`.", + "type": "boolean" + }, + "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).\"", + "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" + ] + }, + "forced": { + "description": "Whether this push was a force push of the `ref`.", + "type": "boolean" + }, + "head_commit": { + "title": "Commit", + "type": [ + "object", + "null" + ], + "properties": { + "added": { + "description": "An array of files added in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + }, "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).\"", @@ -1741892,6 +1747783,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1745227,6 +1751161,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1748562,6 +1754539,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1749652,6 +1755672,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1750570,6 +1756633,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." @@ -1751491,6 +1757597,49 @@ "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, + "dismissal_restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "title": "Actor", + "description": "An actor allowed to dismiss pull request reviews", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the actor that can dismiss reviews." + }, + "type": { + "type": "string", + "description": "The type of the actor", + "enum": [ + "User", + "Team", + "IntegrationInstallation", + "RepositoryRole" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." 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 3f358d5b70..de18a2121c 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -22843,144 +22843,152 @@ paths: content: application/json: schema: - type: array - description: Array of vulnerabilities in OSV format to synchronize - items: - title: OSV Vulnerability - description: A vulnerability in OSV (Open Source Vulnerability) format - type: object - required: - - id - properties: - id: - type: string - description: Unique identifier for the vulnerability from the - external system - examples: - - MVS-2026-001 - schema_version: - type: string - description: The OSV schema version - examples: - - 1.4.0 - summary: - type: string - description: A short summary of the vulnerability - examples: - - Example vulnerability summary - details: - type: string - description: Detailed description of the vulnerability - aliases: - type: array - description: IDs for the same vulnerability in other databases. - Only CVE IDs are used (to populate the vulnerability's CVE identifier); - other aliases are ignored. - items: - type: string - examples: - - CVE-2026-12345 - severity: - type: array - description: Severity information for the vulnerability - items: - type: object - properties: - type: - type: string - description: The type of severity scoring (e.g., CVSS_V3) - score: + type: object + required: + - vulnerabilities + properties: + vulnerabilities: + type: array + description: Array of vulnerabilities in OSV format to synchronize + items: + title: OSV Vulnerability + description: A vulnerability in OSV (Open Source Vulnerability) + format + type: object + required: + - id + properties: + id: + type: string + description: Unique identifier for the vulnerability from + the external system + examples: + - MVS-2026-001 + schema_version: + type: string + description: The OSV schema version + examples: + - 1.4.0 + summary: + type: string + description: A short summary of the vulnerability + examples: + - Example vulnerability summary + details: + type: string + description: Detailed description of the vulnerability + aliases: + type: array + description: IDs for the same vulnerability in other databases. + Only CVE IDs are used (to populate the vulnerability's CVE + identifier); other aliases are ignored. + items: type: string - description: The severity score or vector string - affected: - type: array - description: Packages and versions affected by the vulnerability - items: - type: object - properties: - package: + examples: + - CVE-2026-12345 + severity: + type: array + description: Severity information for the vulnerability + items: type: object properties: - ecosystem: + type: type: string - description: The package ecosystem (e.g., npm, pip, - maven) - name: + description: The type of severity scoring (e.g., CVSS_V3) + score: type: string - description: The package name - ranges: - type: array - items: - type: object - properties: - type: - type: string - events: - type: array - items: - type: object - properties: - introduced: - type: string - description: The version that introduced the - vulnerability - fixed: - type: string - description: The version that fixed the vulnerability - last_affected: - type: string - description: The last affected version - limit: - type: string - description: The upper limit of the affected - range - references: - type: array - description: URLs for more information about the vulnerability - items: - type: object - properties: - type: - type: string - description: 'The type of reference. Supported values: PACKAGE, - ADVISORY, WEB, FIX, ARTICLE, REPORT, EVIDENCE. References - with other types are ignored.' - url: - type: string - format: uri - description: The reference URL - published: - type: string - format: date-time - description: When the vulnerability was first published - modified: - type: string - format: date-time - description: When the vulnerability was last modified - withdrawn: - type: string - format: date-time - description: When the vulnerability was withdrawn. If present, - the vulnerability will be marked as withdrawn. - minItems: 1 - maxItems: 100 + description: The severity score or vector string + affected: + type: array + description: Packages and versions affected by the vulnerability + items: + type: object + properties: + package: + type: object + properties: + ecosystem: + type: string + description: The package ecosystem (e.g., npm, pip, + maven) + name: + type: string + description: The package name + ranges: + type: array + items: + type: object + properties: + type: + type: string + events: + type: array + items: + type: object + properties: + introduced: + type: string + description: The version that introduced + the vulnerability + fixed: + type: string + description: The version that fixed the + vulnerability + last_affected: + type: string + description: The last affected version + limit: + type: string + description: The upper limit of the affected + range + references: + type: array + description: URLs for more information about the vulnerability + items: + type: object + properties: + type: + type: string + description: 'The type of reference. Supported values: + PACKAGE, ADVISORY, WEB, FIX, ARTICLE, REPORT, EVIDENCE. + References with other types are ignored.' + url: + type: string + format: uri + description: The reference URL + published: + type: string + format: date-time + description: When the vulnerability was first published + modified: + type: string + format: date-time + description: When the vulnerability was last modified + withdrawn: + type: string + format: date-time + description: When the vulnerability was withdrawn. If present, + the vulnerability will be marked as withdrawn. + minItems: 1 + maxItems: 100 examples: default: value: - - id: MVS-2026-001 - schema_version: 1.4.0 - summary: Example vulnerability summary - aliases: - - GHSA-xxxx-xxxx-xxxx - affected: - - package: - ecosystem: npm - name: example-package - ranges: - - type: SEMVER - events: - - introduced: 1.0.0 - - fixed: 1.0.1 + vulnerabilities: + - id: MVS-2026-001 + schema_version: 1.4.0 + summary: Example vulnerability summary + aliases: + - GHSA-xxxx-xxxx-xxxx + affected: + - package: + ecosystem: npm + name: example-package + ranges: + - type: SEMVER + events: + - introduced: 1.0.0 + - fixed: 1.0.1 responses: '202': description: Sync operation accepted for asynchronous processing. Poll the @@ -25214,6 +25222,43 @@ paths: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. + dismissal_restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps allowed + to dismiss pull request reviews. + items: + title: Actor + description: An actor allowed to dismiss pull + request reviews + type: object + properties: + id: + type: integer + description: ID of the actor that can dismiss + reviews. + type: + type: string + description: The type of the actor + enum: + - User + - Team + - IntegrationInstallation + - RepositoryRole + required: + - id + - type + enabled: + type: boolean + description: Whether to restrict review dismissal + to specific actors. + required: + - enabled require_code_owner_review: type: boolean description: Require an approving review in pull requests @@ -233787,44 +233832,2385 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: *4 - required: - - requested_team - - action - - number - - pull_request - - repository - - sender + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: *4 + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: pull_request + supported-webhook-types: + - repository + - organization + - app + pull-request-review-submitted: + post: + summary: |- + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. + + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A review on a pull request was submitted. + operationId: pull-request-review/submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review + 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: pull_request_review + 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: pull_request_review submitted event + type: object + properties: + action: + type: string + enum: + - submitted + enterprise: *877 + installation: *878 + organization: *879 + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments_url: + type: string + format: uri + commits_url: + type: string + format: uri + created_at: + type: string + diff_url: + type: string + format: uri + draft: + type: boolean + head: + type: object + properties: + label: + type: + - string + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull + requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull + requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull + requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull + requests are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository + is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create + pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + format: int64 + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign + off on web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading + #, identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + merge_commit_sha: + type: + - string + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have + for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for + its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: *880 + review: *934 + sender: *4 + required: + - action + - review + - pull_request + - repository + - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -233832,23 +236218,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-submitted: + pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -233862,7 +236248,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review + example: pull_request_review_thread schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -233890,13 +236276,13 @@ webhooks: content: application/json: schema: - title: pull_request_review submitted event + title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - - submitted + - resolved enterprise: *877 installation: *878 organization: *879 @@ -234061,7 +236447,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -234135,7 +236520,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -234479,28 +236863,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -234640,28 +237002,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -234702,13 +237042,6 @@ webhooks: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false visibility: type: string enum: @@ -235128,28 +237461,6 @@ webhooks: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -235289,28 +237600,6 @@ webhooks: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `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). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -235351,13 +237640,6 @@ webhooks: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false visibility: type: string enum: @@ -235661,7 +237943,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -236158,14 +238439,329 @@ webhooks: - auto_merge - active_lock_reason repository: *880 - review: *934 sender: *4 + thread: + type: object + properties: + comments: + type: array + items: + 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. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment + applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers + to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the + comment applies. + type: string + original_line: + description: The line of the blob to which the comment + applies. The last line of the range for a multi-line + comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff + to which the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the + comment applies. + type: string + position: + description: The line index in the diff to which the comment + applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which + the comment belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review + comment belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for + a multi-line comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line + comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for + a multi-line comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, + can be a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - - review + - thread - pull_request - repository - - sender responses: '200': description: Return a 200 status to indicate that the data was received @@ -236173,12 +238769,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - pull-request-review-thread-resolved: + pull-request-review-thread-unresolved: post: summary: |- This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. @@ -236186,8 +238782,9 @@ webhooks: For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: @@ -236231,13 +238828,13 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread resolved event + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - resolved + - unresolved enterprise: *877 installation: *878 organization: *879 @@ -236508,9 +239105,7 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -237192,17 +239787,13 @@ webhooks: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -238035,7 +240626,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -238147,15 +240737,6 @@ webhooks: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -238347,7 +240928,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -238495,9 +241075,7 @@ webhooks: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment - type: - - integer - - 'null' + type: integer original_position: description: The index of the original line in the diff to which the comment applies. @@ -238667,7 +241245,6 @@ webhooks: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -238729,19 +241306,18 @@ webhooks: - repository - organization - app - pull-request-review-thread-unresolved: + pull-request-stacked: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved + description: A pull request was added to a stack. + operationId: pull-request/stacked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -238755,7 +241331,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: pull_request_review_thread + example: pull_request schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -238783,18 +241359,19 @@ webhooks: content: application/json: schema: - title: pull_request_review_thread unresolved event + title: pull_request stacked event type: object properties: action: type: string enum: - - unresolved + - stacked enterprise: *877 installation: *878 + number: *929 organization: *879 pull_request: - title: Simple Pull Request + title: Pull Request type: object properties: _links: @@ -238891,6 +241468,8 @@ webhooks: - too heated - spam - + additions: + type: integer assignee: title: User type: @@ -238954,6 +241533,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -239027,6 +241607,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -239060,7 +241641,9 @@ webhooks: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -239368,6 +241951,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -239507,6 +242112,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -239547,6 +242174,13 @@ webhooks: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false visibility: type: string enum: @@ -239721,34 +242355,50 @@ webhooks: type: - string - 'null' + changed_files: + type: integer closed_at: type: - string - 'null' + format: date-time + comments: + type: integer comments_url: type: string format: uri + commits: + type: integer commits_url: type: string format: uri created_at: type: string + format: date-time + deletions: + type: integer diff_url: type: string format: uri draft: + description: Indicates whether or not the pull request is a + draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -239962,6 +242612,28 @@ webhooks: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -240101,6 +242773,28 @@ webhooks: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `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). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -240141,6 +242835,13 @@ webhooks: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the + pull request title as default. **This property is + closing down. Please use `squash_merge_commit_title` + instead. + type: boolean + default: false visibility: type: string enum: @@ -240356,14 +243057,101 @@ webhooks: - description locked: type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull + request. + type: boolean merge_commit_sha: type: - string - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' merged_at: type: - string - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -240444,6 +243232,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -240511,10 +243300,16 @@ webhooks: node_id: type: string number: + description: Number uniquely identifying the pull request within + its repository. type: integer patch_url: type: string format: uri + rebaseable: + type: + - boolean + - 'null' requested_reviewers: type: array items: @@ -240581,6 +243376,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -240692,6 +243488,15 @@ webhooks: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -240801,10 +243606,13 @@ webhooks: review_comment_url: type: string format: uri-template + review_comments: + type: integer review_comments_url: type: string format: uri state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -240813,9 +243621,11 @@ webhooks: type: string format: uri title: + description: The title of the pull request. type: string updated_at: type: string + format: date-time url: type: string format: uri @@ -240883,6 +243693,7 @@ webhooks: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -240916,7 +243727,6 @@ webhooks: - requested_teams - labels - milestone - - draft - commits_url - review_comments_url - review_comment_url @@ -240928,327 +243738,15 @@ webhooks: - author_association - auto_merge - active_lock_reason + - draft repository: *880 sender: *4 - thread: - type: object - properties: - comments: - type: array - items: - 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. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment - applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers - to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the - comment applies. - type: string - original_line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: integer - original_position: - description: The index of the original line in the diff - to which the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the - comment applies. - type: string - position: - description: The line index in the diff to which the comment - applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which - the comment belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review - comment belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for - a multi-line comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line - comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for - a multi-line comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, - can be a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - {"code":"deadline_exceeded","msg":"operation timed out"}