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 7f7a93b0a..26b7b51da 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 @@ -15894,6 +15894,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "$ref": "#/components/schemas/code-scanning-options" }, @@ -16376,6 +16386,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -82711,6 +82730,192 @@ } } }, + "issue-comment-pinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-pinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-unpinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "issue-dependencies-blocked-by-added": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\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.", @@ -102133,14 +102338,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -107031,6 +107228,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -113419,7 +113626,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -118673,7 +118880,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118720,7 +118927,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118767,7 +118974,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118814,7 +119021,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118861,7 +119068,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -132984,6 +133191,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -143164,6 +143381,16 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -144160,13 +144387,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -145608,13 +145828,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -154275,13 +154488,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -155128,13 +155334,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -155974,13 +156173,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -160211,13 +160403,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -164960,13 +165145,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -165619,13 +165797,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -169122,6 +169293,16 @@ "type": "string", "format": "uri" }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] + }, "user": { "title": "User", "type": [ @@ -170209,13 +170390,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -171850,13 +172024,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -173500,13 +173667,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -174162,244 +174322,18 @@ "sender" ] }, - "webhook-issue-dependencies-blocked-by-added": { - "title": "blocked by issue added event", + "webhook-issue-comment-pinned": { + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "blocked_by_added" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocked-by-removed": { - "title": "blocked by issue removed event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocked_by_removed" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocking-added": { - "title": "blocking issue added event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocking_added" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocked_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocking-removed": { - "title": "blocking issue removed event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocking_removed" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocked_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issues-assigned": { - "title": "issues assigned event", - "type": "object", - "properties": { - "action": { - "description": "The action that was performed.", - "type": "string", - "enum": [ - "assigned" + "pinned" ] }, - "assignee": { - "$ref": "#/components/schemas/webhooks_user" - }, - "enterprise": { - "$ref": "#/components/schemas/enterprise-webhooks" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "issue": { - "$ref": "#/components/schemas/webhooks_issue" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "issue", - "repository", - "sender" - ] - }, - "webhook-issues-closed": { - "title": "issues closed event", - "type": "object", - "properties": { - "action": { - "description": "The action that was performed.", - "type": "string", - "enum": [ - "closed" - ] + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -174408,7 +174342,7 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", @@ -175012,10 +174946,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -175270,8 +175201,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -175506,12 +175436,6 @@ "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, - "issue_field_values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -175682,9 +175606,103 @@ ] }, "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": { @@ -175732,9 +175750,46 @@ "labels": { "type": "array", "items": { - "type": [ - "object", - "null" + "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" ] } }, @@ -175801,10 +175856,11 @@ "type": "string" }, "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ - "closed", - "open" + "open", + "closed" ] }, "timeline_url": { @@ -175884,8 +175940,10 @@ } }, "required": [ + "labels", "state", - "closed_at" + "locked", + "assignee" ] } ] @@ -175903,20 +175961,24 @@ "required": [ "action", "issue", + "comment", "repository", "sender" ] }, - "webhook-issues-deleted": { - "title": "issues deleted event", + "webhook-issue-comment-unpinned": { + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "unpinned" ] }, + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" + }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, @@ -175924,355 +175986,3734 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "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" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "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" - }, - "user_view_type": { - "type": "string" - } - }, - "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" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "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" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "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": { + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-added": { + "title": "blocked by issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-removed": { + "title": "blocked by issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-added": { + "title": "blocking issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-removed": { + "title": "blocking issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issues-assigned": { + "title": "issues assigned event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "assigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-closed": { + "title": "issues closed event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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", + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-deleted": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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", @@ -176879,13 +180320,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178201,13 +181635,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -179492,13 +182919,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -180787,13 +184207,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -182121,13 +185534,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183408,13 +186814,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -184665,13 +188064,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -186544,13 +189936,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -187905,13 +191290,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -189156,13 +192534,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -191248,13 +194619,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -294162,7 +297526,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -297716,7 +301079,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -297737,61 +301100,59 @@ ] }, "org-ruleset-version-with-state": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } }, "organization-secret-scanning-alert-list": { "value": [ @@ -311513,51 +314874,49 @@ } }, "repository-ruleset-version-with-state": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } }, "secret-scanning-alert-list": { "value": [ @@ -316844,7 +320203,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -316899,7 +320257,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317170,7 +320527,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317225,7 +320581,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317483,7 +320838,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317538,7 +320892,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317824,7 +321177,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317879,7 +321231,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] 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 e597318f3..3ea25f652 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 @@ -11477,6 +11477,15 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled code_scanning_options: "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: @@ -11853,6 +11862,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -59718,284 +59735,18 @@ webhooks: - repository - organization - app - issue-dependencies-blocked-by-added: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocked by another issue. - operationId: issue-dependencies/blocked-by-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocked-by-removed: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocked by relationship between an issue and another issue - was removed. - operationId: issue-dependencies/blocked-by-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocking-added: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocking another issue. - operationId: issue-dependencies/blocking-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocking-removed: + issue-comment-pinned: post: summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocking relationship between an issue and another issue was - removed. - operationId: issue-dependencies/blocking-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issues-assigned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was assigned to a user. - operationId: issues/assigned + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -60037,7 +59788,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60045,23 +59796,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-closed: + issue-comment-unpinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was closed. - operationId: issues/closed + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -60103,7 +59854,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60111,23 +59862,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-deleted: + issue-dependencies-blocked-by-added: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocked by another issue. + operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -60169,7 +59920,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60177,23 +59928,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-demilestoned: + issue-dependencies-blocked-by-removed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocked by relationship between an issue and another issue + was removed. + operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -60235,7 +59987,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60243,12 +59995,145 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-edited: + issue-dependencies-blocking-added: + post: + summary: |- + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocking another issue. + operationId: issue-dependencies/blocking-added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue-dependencies + supported-webhook-types: + - repository + - organization + - app + issue-dependencies-blocking-removed: + post: + summary: |- + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocking relationship between an issue and another issue was + removed. + operationId: issue-dependencies/blocking-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue-dependencies + supported-webhook-types: + - repository + - organization + - app + issues-assigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60256,8 +60141,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited + description: An issue was assigned to a user. + operationId: issues/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60301,7 +60186,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60314,7 +60199,7 @@ webhooks: - repository - organization - app - issues-labeled: + issues-closed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60322,8 +60207,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue was closed. + operationId: issues/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60367,7 +60252,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60380,7 +60265,7 @@ webhooks: - repository - organization - app - issues-locked: + issues-deleted: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60388,9 +60273,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60434,7 +60318,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60447,7 +60331,7 @@ webhooks: - repository - organization - app - issues-milestoned: + issues-demilestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60455,8 +60339,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: An issue was removed from a milestone. + operationId: issues/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60500,7 +60384,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60513,7 +60397,7 @@ webhooks: - repository - organization - app - issues-opened: + issues-edited: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60521,9 +60405,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: The title or body on an issue was edited. + operationId: issues/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60567,7 +60450,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60580,7 +60463,7 @@ webhooks: - repository - organization - app - issues-pinned: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60588,9 +60471,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60634,7 +60516,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60647,7 +60529,7 @@ webhooks: - repository - organization - app - issues-reopened: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60655,8 +60537,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60700,7 +60583,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60713,7 +60596,7 @@ webhooks: - repository - organization - app - issues-transferred: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60721,9 +60604,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60767,7 +60649,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60780,7 +60662,7 @@ webhooks: - repository - organization - app - issues-typed: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60788,8 +60670,275 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-opened" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-pinned: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-pinned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-reopened: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A closed issue was reopened. + operationId: issues/reopened + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-reopened" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-transferred: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-transferred" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-typed: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -73647,13 +73796,6 @@ components: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access token to manage - team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access token to manage @@ -77374,6 +77516,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - id - node_id @@ -82115,7 +82261,7 @@ components: cli: type: string description: The organization policy for allowing or disallowing Copilot - in the CLI. + CLI. enum: - enabled - disabled @@ -86080,7 +86226,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86114,7 +86260,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86148,7 +86294,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86182,7 +86328,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86216,7 +86362,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -96380,6 +96526,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - event - actor @@ -103639,6 +103789,10 @@ components: required: - login - id + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - url - html_url @@ -104383,11 +104537,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -105459,11 +105608,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -111906,11 +112050,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -112550,11 +112689,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113187,11 +113321,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -116362,11 +116491,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -119708,11 +119832,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -120201,11 +120320,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122669,6 +122783,10 @@ components: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" user: title: User type: @@ -123482,11 +123600,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -124685,11 +124798,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125895,11 +126003,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -126365,182 +126468,23 @@ components: - comment - repository - sender - webhook-issue-dependencies-blocked-by-added: - title: blocked by issue added event + webhook-issue-comment-pinned: + title: issue_comment pinned event type: object properties: action: type: string enum: - - blocked_by_added - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_repo: - "$ref": "#/components/schemas/repository" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issue-dependencies-blocked-by-removed: - title: blocked by issue removed event - type: object - properties: - action: - type: string - enum: - - blocked_by_removed - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_repo: - "$ref": "#/components/schemas/repository" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issue-dependencies-blocking-added: - title: blocking issue added event - type: object - properties: - action: - type: string - enum: - - blocking_added - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocked_issue_repo: - "$ref": "#/components/schemas/repository" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issue-dependencies-blocking-removed: - title: blocking issue removed event - type: object - properties: - action: - type: string - enum: - - blocking_removed - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocked_issue_repo: - "$ref": "#/components/schemas/repository" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issues-assigned: - title: issues assigned event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - assigned - assignee: - "$ref": "#/components/schemas/webhooks_user" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - "$ref": "#/components/schemas/webhooks_issue" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-closed: - title: issues closed event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - closed + - pinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + the comment belongs to. allOf: - title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127005,9 +126949,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - reminder - - pull_request_review_thread external_url: type: - string @@ -127191,7 +127132,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -127358,10 +127298,2578 @@ components: "$ref": "#/components/schemas/sub-issues-summary" issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" - issue_field_values: - type: array - items: - "$ref": "#/components/schemas/issue-field-value" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + 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 + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - '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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + 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 + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-comment-unpinned: + title: issue_comment unpinned event + type: object + properties: + action: + type: string + enum: + - unpinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + 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 + user_view_type: + type: string + 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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + 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 + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + 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 + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + 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 + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - '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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + 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 + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event + type: object + properties: + action: + type: string + enum: + - blocked_by_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocked-by-removed: + title: blocked by issue removed event + type: object + properties: + action: + type: string + enum: + - blocked_by_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-added: + title: blocking issue added event + type: object + properties: + action: + type: string + enum: + - blocking_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-removed: + title: blocking issue removed event + type: object + properties: + action: + type: string + enum: + - blocking_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issues-assigned: + title: issues assigned event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - assigned + assignee: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-closed: + title: issues closed event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - closed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + 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 + user_view_type: + type: string + 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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + 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 + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - security_and_analysis + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + 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 + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128195,997 +130703,9 @@ components: format: uri user_view_type: type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - 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 - repository_url: - type: string - format: uri - sub_issues_summary: - "$ref": "#/components/schemas/sub-issues-summary" - issue_dependencies_summary: - "$ref": "#/components/schemas/issue-dependencies-summary" - issue_field_values: - type: array - items: - "$ref": "#/components/schemas/issue-field-value" - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: - "$ref": "#/components/schemas/issue-type" - updated_at: - type: string - format: date-time - url: - description: URL for the issue - 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 - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-demilestoned: - title: issues demilestoned event - type: object - properties: - action: - type: string - enum: - - demilestoned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - required: - - login - - id - 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 - assignees: - type: array - items: - title: User - type: - - object - - 'null' - required: - - login - - id - 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 - 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: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: - - object - - 'null' - required: - - id - - node_id - - url - - name - - color - - default - - description - 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 - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - 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 - 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' - required: - - login - - id - 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 - 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 - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They can be - installed directly on organizations and user accounts and granted - access to specific repositories. They come with granular permissions - and built-in webhooks. GitHub apps are first class actors within GitHub. - type: - - object - - 'null' - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - required: - - login - - id - 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: description: The set of permissions for the GitHub app type: object @@ -129280,7 +130800,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -129351,11 +130870,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129374,6 +130888,16 @@ components: - string - 'null' format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -129397,17 +130921,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -129430,6 +130943,17 @@ components: url: type: string format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket repository_url: type: string format: uri @@ -129471,9 +130995,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -129533,14 +131054,36 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri user_view_type: type: string - milestone: - "$ref": "#/components/schemas/webhooks_milestone" + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -129552,34 +131095,14 @@ components: - issue - repository - sender - webhook-issues-edited: - title: issues edited event + webhook-issues-demilestoned: + title: issues demilestoned event type: object properties: action: type: string enum: - - edited - changes: - description: The changes to the issue. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title. - type: string - required: - - from + - demilestoned enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -129589,6 +131112,28 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user properties: active_lock_reason: type: @@ -129605,6 +131150,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129667,11 +131215,6 @@ components: url: type: string format: uri - user_view_type: - type: string - required: - - login - - id assignees: type: array items: @@ -129679,6 +131222,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129741,9 +131287,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -129790,7 +131333,17 @@ components: type: array items: title: Label - type: object + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description properties: color: description: '6-character hex code, without the leading #, identifying @@ -129813,14 +131366,6 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template @@ -129832,6 +131377,23 @@ components: type: - object - 'null' + 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 properties: closed_at: type: @@ -129848,6 +131410,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129912,9 +131477,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id description: type: - string @@ -129954,23 +131516,6 @@ components: 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: @@ -129984,6 +131529,16 @@ components: type: - object - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: @@ -130045,9 +131600,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - - reminder external_url: type: - string @@ -130071,6 +131623,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -130134,9 +131689,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -130302,11 +131854,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130325,16 +131872,6 @@ components: - string - 'null' format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -130358,6 +131895,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -130380,17 +131928,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -130415,11 +131952,11 @@ components: timeline_url: type: string format: uri - type: - "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -130432,6 +131969,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -130497,33 +132037,8 @@ components: format: uri user_view_type: type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: - "$ref": "#/components/schemas/webhooks_label" + milestone: + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -130532,18 +132047,37 @@ components: "$ref": "#/components/schemas/simple-user" required: - action - - changes - issue - repository - sender - webhook-issues-labeled: - title: issues labeled event + webhook-issues-edited: + title: issues edited event type: object properties: action: type: string enum: - - labeled + - edited + changes: + description: The changes to the issue. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + title: + type: object + properties: + from: + description: The previous version of the title. + type: string + required: + - from enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -131009,6 +132543,7 @@ components: - watch - workflow_dispatch - workflow_run + - security_and_analysis - pull_request_review_thread - reminder external_url: @@ -131265,11 +132800,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131495,17 +133025,18 @@ components: "$ref": "#/components/schemas/simple-user" required: - action + - changes - issue - repository - sender - webhook-issues-locked: - title: issues locked event + webhook-issues-labeled: + title: issues labeled event type: object properties: action: type: string enum: - - locked + - labeled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -131515,29 +133046,6 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - locked - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user properties: active_lock_reason: type: @@ -131554,9 +133062,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131615,11 +133120,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id assignees: type: array items: @@ -131627,9 +133136,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131688,11 +133194,13 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri - user_view_type: - type: string + required: + - login + - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -131739,17 +133247,7 @@ components: type: array items: title: Label - type: - - object - - 'null' - required: - - id - - node_id - - url - - name - - color - - default - - description + type: object properties: color: description: '6-character hex code, without the leading #, identifying @@ -131772,36 +133270,25 @@ components: description: URL for the label type: string format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description labels_url: type: string format: uri-template locked: type: boolean - enum: - - true milestone: title: Milestone description: A collection of related issues and pull requests. type: - object - 'null' - 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 properties: closed_at: type: @@ -131818,9 +133305,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131879,11 +133363,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: - string @@ -131923,6 +133411,23 @@ components: 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: @@ -131936,16 +133441,6 @@ components: type: - object - 'null' - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: @@ -132007,8 +133502,8 @@ components: - watch - workflow_dispatch - workflow_run + - pull_request_review_thread - reminder - - security_and_analysis external_url: type: - string @@ -132032,9 +133527,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -132098,6 +133590,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -132192,6 +133687,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -132262,11 +133758,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -132285,6 +133776,16 @@ components: - string - 'null' format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -132308,17 +133809,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -132341,6 +133831,17 @@ components: url: type: string format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket repository_url: type: string format: uri @@ -132382,9 +133883,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -132444,11 +133942,39 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + label: + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -132460,14 +133986,14 @@ components: - issue - repository - sender - webhook-issues-milestoned: - title: issues milestoned event + webhook-issues-locked: + title: issues locked event type: object properties: action: type: string enum: - - milestoned + - locked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -132490,6 +134016,7 @@ components: - html_url - id - labels_url + - locked - milestone - node_id - number @@ -132579,6 +134106,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -132650,6 +134179,8 @@ components: url: type: string format: uri + user_view_type: + type: string author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -132734,6 +134265,8 @@ components: format: uri-template locked: type: boolean + enum: + - true milestone: title: Milestone description: A collection of related issues and pull requests. @@ -132834,7 +134367,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -132964,6 +134496,7 @@ components: - workflow_dispatch - workflow_run - reminder + - security_and_analysis external_url: type: - string @@ -133147,7 +134680,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -133218,7 +134750,953 @@ components: enum: - read - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + 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 + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + type: + "$ref": "#/components/schemas/issue-type" + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + required: + - login + - id + 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 + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-milestoned: + title: issues milestoned event + type: object + properties: + action: + type: string + enum: + - milestoned + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + 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 + assignees: + type: array + items: + title: User + type: + - object + - 'null' + required: + - login + - id + 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 + 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: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + 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 + 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' + required: + - login + - id + 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 + 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 + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can be + installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within GitHub. + type: + - object + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + 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 + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -134146,11 +136624,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135545,11 +138018,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136562,11 +139030,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137486,11 +139949,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139048,11 +141506,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -217046,7 +219499,6 @@ components: - subject_type: installation subject_id: 954453 subject_name: GitHub Actions - integration_id: 124345 total_request_count: 544665 rate_limited_request_count: 13 last_request_timestamp: '2024-09-18T15:43:03Z' @@ -220101,7 +222553,7 @@ components: actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' - version_id: 2 actor: id: 2 @@ -220114,11 +222566,11 @@ components: updated_at: '2024-08-23T16:29:47Z' org-ruleset-version-with-state: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 21 name: super cool ruleset @@ -231937,11 +234389,11 @@ components: updated_at: '2023-08-23T16:29:47Z' repository-ruleset-version-with-state: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 42 name: super cool ruleset @@ -236531,7 +238983,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -236582,7 +239033,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -236826,7 +239276,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -236877,7 +239326,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -237109,7 +239557,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -237160,7 +239607,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -237417,7 +239863,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -237468,7 +239913,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 7f7a93b0a..26b7b51da 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -15894,6 +15894,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "$ref": "#/components/schemas/code-scanning-options" }, @@ -16376,6 +16386,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -82711,6 +82730,192 @@ } } }, + "issue-comment-pinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-pinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-unpinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "issue-dependencies-blocked-by-added": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\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.", @@ -102133,14 +102338,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -107031,6 +107228,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -113419,7 +113626,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -118673,7 +118880,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118720,7 +118927,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118767,7 +118974,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118814,7 +119021,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -118861,7 +119068,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -132984,6 +133191,16 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -143164,6 +143381,16 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] } }, "required": [ @@ -144160,13 +144387,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -145608,13 +145828,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -154275,13 +154488,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -155128,13 +155334,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -155974,13 +156173,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -160211,13 +160403,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -164960,13 +165145,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -165619,13 +165797,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -169122,6 +169293,16 @@ "type": "string", "format": "uri" }, + "pin": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/pinned-issue-comment" + } + ] + }, "user": { "title": "User", "type": [ @@ -170209,13 +170390,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -171850,13 +172024,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -173500,13 +173667,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -174162,244 +174322,18 @@ "sender" ] }, - "webhook-issue-dependencies-blocked-by-added": { - "title": "blocked by issue added event", + "webhook-issue-comment-pinned": { + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "blocked_by_added" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocked-by-removed": { - "title": "blocked by issue removed event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocked_by_removed" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocking_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocking-added": { - "title": "blocking issue added event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocking_added" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocked_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issue-dependencies-blocking-removed": { - "title": "blocking issue removed event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "blocking_removed" - ] - }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "$ref": "#/components/schemas/issue" - }, - "blocked_issue_repo": { - "$ref": "#/components/schemas/repository" - }, - "blocking_issue_id": { - "description": "The ID of the blocking issue.", - "type": "number" - }, - "blocking_issue": { - "$ref": "#/components/schemas/issue" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "organization", - "repository", - "sender" - ] - }, - "webhook-issues-assigned": { - "title": "issues assigned event", - "type": "object", - "properties": { - "action": { - "description": "The action that was performed.", - "type": "string", - "enum": [ - "assigned" + "pinned" ] }, - "assignee": { - "$ref": "#/components/schemas/webhooks_user" - }, - "enterprise": { - "$ref": "#/components/schemas/enterprise-webhooks" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "issue": { - "$ref": "#/components/schemas/webhooks_issue" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "issue", - "repository", - "sender" - ] - }, - "webhook-issues-closed": { - "title": "issues closed event", - "type": "object", - "properties": { - "action": { - "description": "The action that was performed.", - "type": "string", - "enum": [ - "closed" - ] + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -174408,7 +174342,7 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", @@ -175012,10 +174946,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -175270,8 +175201,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -175506,12 +175436,6 @@ "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, - "issue_field_values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/issue-field-value" - } - }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -175682,9 +175606,103 @@ ] }, "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": { @@ -175732,9 +175750,46 @@ "labels": { "type": "array", "items": { - "type": [ - "object", - "null" + "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" ] } }, @@ -175801,10 +175856,11 @@ "type": "string" }, "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ - "closed", - "open" + "open", + "closed" ] }, "timeline_url": { @@ -175884,8 +175940,10 @@ } }, "required": [ + "labels", "state", - "closed_at" + "locked", + "assignee" ] } ] @@ -175903,20 +175961,24 @@ "required": [ "action", "issue", + "comment", "repository", "sender" ] }, - "webhook-issues-deleted": { - "title": "issues deleted event", + "webhook-issue-comment-unpinned": { + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "unpinned" ] }, + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" + }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, @@ -175924,355 +175986,3734 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": [ - "string", - "null" - ], - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", - "type": [ - "object", - "null" - ], + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { + "active_lock_reason": { "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" + "resolved", + "off-topic", + "too heated", + "spam", + null ] }, - "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" - }, - "user_view_type": { - "type": "string" - } - }, - "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" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "comments": { - "type": "integer" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "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" - ] - } - }, - "labels_url": { - "type": "string", - "format": "uri-template" - }, - "locked": { - "type": "boolean" - }, - "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": { + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-added": { + "title": "blocked by issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-removed": { + "title": "blocked by issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-added": { + "title": "blocking issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-removed": { + "title": "blocking issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issues-assigned": { + "title": "issues assigned event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "assigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-closed": { + "title": "issues closed event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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", + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "type": [ + "object", + "null" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-deleted": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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", @@ -176879,13 +180320,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178201,13 +181635,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -179492,13 +182919,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -180787,13 +184207,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -182121,13 +185534,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183408,13 +186814,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -184665,13 +188064,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -186544,13 +189936,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -187905,13 +191290,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -189156,13 +192534,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -191248,13 +194619,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -294162,7 +297526,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -297716,7 +301079,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -297737,61 +301100,59 @@ ] }, "org-ruleset-version-with-state": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } }, "organization-secret-scanning-alert-list": { "value": [ @@ -311513,51 +314874,49 @@ } }, "repository-ruleset-version-with-state": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } }, "secret-scanning-alert-list": { "value": [ @@ -316844,7 +320203,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -316899,7 +320257,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317170,7 +320527,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317225,7 +320581,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317483,7 +320838,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317538,7 +320892,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317824,7 +321177,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -317879,7 +321231,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index e597318f3..3ea25f652 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -11477,6 +11477,15 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled code_scanning_options: "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: @@ -11853,6 +11862,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -59718,284 +59735,18 @@ webhooks: - repository - organization - app - issue-dependencies-blocked-by-added: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocked by another issue. - operationId: issue-dependencies/blocked-by-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocked-by-removed: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocked by relationship between an issue and another issue - was removed. - operationId: issue-dependencies/blocked-by-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocking-added: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocking another issue. - operationId: issue-dependencies/blocking-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocking-removed: + issue-comment-pinned: post: summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocking relationship between an issue and another issue was - removed. - operationId: issue-dependencies/blocking-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issues-assigned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was assigned to a user. - operationId: issues/assigned + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -60037,7 +59788,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60045,23 +59796,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-closed: + issue-comment-unpinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was closed. - operationId: issues/closed + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -60103,7 +59854,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60111,23 +59862,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-deleted: + issue-dependencies-blocked-by-added: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocked by another issue. + operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -60169,7 +59920,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60177,23 +59928,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-demilestoned: + issue-dependencies-blocked-by-removed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocked by relationship between an issue and another issue + was removed. + operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -60235,7 +59987,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60243,12 +59995,145 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-edited: + issue-dependencies-blocking-added: + post: + summary: |- + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocking another issue. + operationId: issue-dependencies/blocking-added + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue-dependencies + supported-webhook-types: + - repository + - organization + - app + issue-dependencies-blocking-removed: + post: + summary: |- + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocking relationship between an issue and another issue was + removed. + operationId: issue-dependencies/blocking-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue-dependencies + supported-webhook-types: + - repository + - organization + - app + issues-assigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60256,8 +60141,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited + description: An issue was assigned to a user. + operationId: issues/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60301,7 +60186,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60314,7 +60199,7 @@ webhooks: - repository - organization - app - issues-labeled: + issues-closed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60322,8 +60207,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + description: An issue was closed. + operationId: issues/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60367,7 +60252,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60380,7 +60265,7 @@ webhooks: - repository - organization - app - issues-locked: + issues-deleted: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60388,9 +60273,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60434,7 +60318,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60447,7 +60331,7 @@ webhooks: - repository - organization - app - issues-milestoned: + issues-demilestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60455,8 +60339,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: An issue was removed from a milestone. + operationId: issues/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60500,7 +60384,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60513,7 +60397,7 @@ webhooks: - repository - organization - app - issues-opened: + issues-edited: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60521,9 +60405,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: The title or body on an issue was edited. + operationId: issues/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60567,7 +60450,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60580,7 +60463,7 @@ webhooks: - repository - organization - app - issues-pinned: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60588,9 +60471,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60634,7 +60516,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60647,7 +60529,7 @@ webhooks: - repository - organization - app - issues-reopened: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60655,8 +60537,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60700,7 +60583,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60713,7 +60596,7 @@ webhooks: - repository - organization - app - issues-transferred: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60721,9 +60604,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -60767,7 +60649,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60780,7 +60662,7 @@ webhooks: - repository - organization - app - issues-typed: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -60788,8 +60670,275 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-opened" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-pinned: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-pinned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-reopened: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A closed issue was reopened. + operationId: issues/reopened + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-reopened" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-transferred: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-transferred" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issues + supported-webhook-types: + - repository + - organization + - app + issues-typed: + post: + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -73647,13 +73796,6 @@ components: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access token to manage - team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access token to manage @@ -77374,6 +77516,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - id - node_id @@ -82115,7 +82261,7 @@ components: cli: type: string description: The organization policy for allowing or disallowing Copilot - in the CLI. + CLI. enum: - enabled - disabled @@ -86080,7 +86226,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86114,7 +86260,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86148,7 +86294,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86182,7 +86328,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -86216,7 +86362,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -96380,6 +96526,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - event - actor @@ -103639,6 +103789,10 @@ components: required: - login - id + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - url - html_url @@ -104383,11 +104537,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -105459,11 +105608,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -111906,11 +112050,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -112550,11 +112689,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113187,11 +113321,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -116362,11 +116491,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -119708,11 +119832,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -120201,11 +120320,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122669,6 +122783,10 @@ components: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" user: title: User type: @@ -123482,11 +123600,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -124685,11 +124798,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125895,11 +126003,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -126365,182 +126468,23 @@ components: - comment - repository - sender - webhook-issue-dependencies-blocked-by-added: - title: blocked by issue added event + webhook-issue-comment-pinned: + title: issue_comment pinned event type: object properties: action: type: string enum: - - blocked_by_added - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_repo: - "$ref": "#/components/schemas/repository" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issue-dependencies-blocked-by-removed: - title: blocked by issue removed event - type: object - properties: - action: - type: string - enum: - - blocked_by_removed - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - blocking_issue_repo: - "$ref": "#/components/schemas/repository" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issue-dependencies-blocking-added: - title: blocking issue added event - type: object - properties: - action: - type: string - enum: - - blocking_added - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocked_issue_repo: - "$ref": "#/components/schemas/repository" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issue-dependencies-blocking-removed: - title: blocking issue removed event - type: object - properties: - action: - type: string - enum: - - blocking_removed - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: - "$ref": "#/components/schemas/issue" - blocked_issue_repo: - "$ref": "#/components/schemas/repository" - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: - "$ref": "#/components/schemas/issue" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - organization - - repository - - sender - webhook-issues-assigned: - title: issues assigned event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - assigned - assignee: - "$ref": "#/components/schemas/webhooks_user" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - "$ref": "#/components/schemas/webhooks_issue" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-closed: - title: issues closed event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - closed + - pinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + the comment belongs to. allOf: - title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127005,9 +126949,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - reminder - - pull_request_review_thread external_url: type: - string @@ -127191,7 +127132,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -127358,10 +127298,2578 @@ components: "$ref": "#/components/schemas/sub-issues-summary" issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" - issue_field_values: - type: array - items: - "$ref": "#/components/schemas/issue-field-value" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + 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 + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - '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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + 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 + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-comment-unpinned: + title: issue_comment unpinned event + type: object + properties: + action: + type: string + enum: + - unpinned + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + 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 + user_view_type: + type: string + 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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + 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 + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + 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 + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + 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 + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - '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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + 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 + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event + type: object + properties: + action: + type: string + enum: + - blocked_by_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocked-by-removed: + title: blocked by issue removed event + type: object + properties: + action: + type: string + enum: + - blocked_by_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-added: + title: blocking issue added event + type: object + properties: + action: + type: string + enum: + - blocking_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issue-dependencies-blocking-removed: + title: blocking issue removed event + type: object + properties: + action: + type: string + enum: + - blocking_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - organization + - repository + - sender + webhook-issues-assigned: + title: issues assigned event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - assigned + assignee: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-closed: + title: issues closed event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - closed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + 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 + user_view_type: + type: string + 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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + 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 + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - security_and_analysis + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + 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 + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128195,997 +130703,9 @@ components: format: uri user_view_type: type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - 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 - repository_url: - type: string - format: uri - sub_issues_summary: - "$ref": "#/components/schemas/sub-issues-summary" - issue_dependencies_summary: - "$ref": "#/components/schemas/issue-dependencies-summary" - issue_field_values: - type: array - items: - "$ref": "#/components/schemas/issue-field-value" - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: - "$ref": "#/components/schemas/issue-type" - updated_at: - type: string - format: date-time - url: - description: URL for the issue - 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 - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - issue - - repository - - sender - webhook-issues-demilestoned: - title: issues demilestoned event - type: object - properties: - action: - type: string - enum: - - demilestoned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - required: - - login - - id - 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 - assignees: - type: array - items: - title: User - type: - - object - - 'null' - required: - - login - - id - 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 - 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: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: - - object - - 'null' - required: - - id - - node_id - - url - - name - - color - - default - - description - 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 - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - 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 - 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' - required: - - login - - id - 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 - 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 - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They can be - installed directly on organizations and user accounts and granted - access to specific repositories. They come with granular permissions - and built-in webhooks. GitHub apps are first class actors within GitHub. - type: - - object - - 'null' - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - required: - - login - - id - 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: description: The set of permissions for the GitHub app type: object @@ -129280,7 +130800,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -129351,11 +130870,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129374,6 +130888,16 @@ components: - string - 'null' format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -129397,17 +130921,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -129430,6 +130943,17 @@ components: url: type: string format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket repository_url: type: string format: uri @@ -129471,9 +130995,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -129533,14 +131054,36 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri user_view_type: type: string - milestone: - "$ref": "#/components/schemas/webhooks_milestone" + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -129552,34 +131095,14 @@ components: - issue - repository - sender - webhook-issues-edited: - title: issues edited event + webhook-issues-demilestoned: + title: issues demilestoned event type: object properties: action: type: string enum: - - edited - changes: - description: The changes to the issue. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title. - type: string - required: - - from + - demilestoned enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -129589,6 +131112,28 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user properties: active_lock_reason: type: @@ -129605,6 +131150,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129667,11 +131215,6 @@ components: url: type: string format: uri - user_view_type: - type: string - required: - - login - - id assignees: type: array items: @@ -129679,6 +131222,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129741,9 +131287,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -129790,7 +131333,17 @@ components: type: array items: title: Label - type: object + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description properties: color: description: '6-character hex code, without the leading #, identifying @@ -129813,14 +131366,6 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template @@ -129832,6 +131377,23 @@ components: type: - object - 'null' + 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 properties: closed_at: type: @@ -129848,6 +131410,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -129912,9 +131477,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id description: type: - string @@ -129954,23 +131516,6 @@ components: 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: @@ -129984,6 +131529,16 @@ components: type: - object - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: @@ -130045,9 +131600,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - - reminder external_url: type: - string @@ -130071,6 +131623,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -130134,9 +131689,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -130302,11 +131854,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130325,16 +131872,6 @@ components: - string - 'null' format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -130358,6 +131895,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -130380,17 +131928,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -130415,11 +131952,11 @@ components: timeline_url: type: string format: uri - type: - "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -130432,6 +131969,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -130497,33 +132037,8 @@ components: format: uri user_view_type: type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: - "$ref": "#/components/schemas/webhooks_label" + milestone: + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -130532,18 +132047,37 @@ components: "$ref": "#/components/schemas/simple-user" required: - action - - changes - issue - repository - sender - webhook-issues-labeled: - title: issues labeled event + webhook-issues-edited: + title: issues edited event type: object properties: action: type: string enum: - - labeled + - edited + changes: + description: The changes to the issue. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + title: + type: object + properties: + from: + description: The previous version of the title. + type: string + required: + - from enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -131009,6 +132543,7 @@ components: - watch - workflow_dispatch - workflow_run + - security_and_analysis - pull_request_review_thread - reminder external_url: @@ -131265,11 +132800,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131495,17 +133025,18 @@ components: "$ref": "#/components/schemas/simple-user" required: - action + - changes - issue - repository - sender - webhook-issues-locked: - title: issues locked event + webhook-issues-labeled: + title: issues labeled event type: object properties: action: type: string enum: - - locked + - labeled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -131515,29 +133046,6 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - locked - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user properties: active_lock_reason: type: @@ -131554,9 +133062,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131615,11 +133120,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id assignees: type: array items: @@ -131627,9 +133136,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131688,11 +133194,13 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri - user_view_type: - type: string + required: + - login + - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -131739,17 +133247,7 @@ components: type: array items: title: Label - type: - - object - - 'null' - required: - - id - - node_id - - url - - name - - color - - default - - description + type: object properties: color: description: '6-character hex code, without the leading #, identifying @@ -131772,36 +133270,25 @@ components: description: URL for the label type: string format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description labels_url: type: string format: uri-template locked: type: boolean - enum: - - true milestone: title: Milestone description: A collection of related issues and pull requests. type: - object - 'null' - 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 properties: closed_at: type: @@ -131818,9 +133305,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -131879,11 +133363,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: - string @@ -131923,6 +133411,23 @@ components: 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: @@ -131936,16 +133441,6 @@ components: type: - object - 'null' - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: @@ -132007,8 +133502,8 @@ components: - watch - workflow_dispatch - workflow_run + - pull_request_review_thread - reminder - - security_and_analysis external_url: type: - string @@ -132032,9 +133527,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -132098,6 +133590,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -132192,6 +133687,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -132262,11 +133758,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -132285,6 +133776,16 @@ components: - string - 'null' format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -132308,17 +133809,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -132341,6 +133831,17 @@ components: url: type: string format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket repository_url: type: string format: uri @@ -132382,9 +133883,6 @@ components: type: - object - 'null' - required: - - login - - id properties: avatar_url: type: string @@ -132444,11 +133942,39 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + label: + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -132460,14 +133986,14 @@ components: - issue - repository - sender - webhook-issues-milestoned: - title: issues milestoned event + webhook-issues-locked: + title: issues locked event type: object properties: action: type: string enum: - - milestoned + - locked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -132490,6 +134016,7 @@ components: - html_url - id - labels_url + - locked - milestone - node_id - number @@ -132579,6 +134106,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -132650,6 +134179,8 @@ components: url: type: string format: uri + user_view_type: + type: string author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -132734,6 +134265,8 @@ components: format: uri-template locked: type: boolean + enum: + - true milestone: title: Milestone description: A collection of related issues and pull requests. @@ -132834,7 +134367,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -132964,6 +134496,7 @@ components: - workflow_dispatch - workflow_run - reminder + - security_and_analysis external_url: type: - string @@ -133147,7 +134680,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -133218,7 +134750,953 @@ components: enum: - read - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + 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 + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + type: + "$ref": "#/components/schemas/issue-type" + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + required: + - login + - id + 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 + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - repository + - sender + webhook-issues-milestoned: + title: issues milestoned event + type: object + properties: + action: + type: string + enum: + - milestoned + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + 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 + assignees: + type: array + items: + title: User + type: + - object + - 'null' + required: + - login + - id + 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 + 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: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + 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 + 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' + required: + - login + - id + 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 + 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 + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can be + installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within GitHub. + type: + - object + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + 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 + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -134146,11 +136624,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135545,11 +138018,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136562,11 +139030,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137486,11 +139949,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139048,11 +141506,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -217046,7 +219499,6 @@ components: - subject_type: installation subject_id: 954453 subject_name: GitHub Actions - integration_id: 124345 total_request_count: 544665 rate_limited_request_count: 13 last_request_timestamp: '2024-09-18T15:43:03Z' @@ -220101,7 +222553,7 @@ components: actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' - version_id: 2 actor: id: 2 @@ -220114,11 +222566,11 @@ components: updated_at: '2024-08-23T16:29:47Z' org-ruleset-version-with-state: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 21 name: super cool ruleset @@ -231937,11 +234389,11 @@ components: updated_at: '2023-08-23T16:29:47Z' repository-ruleset-version-with-state: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 42 name: super cool ruleset @@ -236531,7 +238983,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -236582,7 +239033,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -236826,7 +239276,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -236877,7 +239326,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -237109,7 +239557,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -237160,7 +239607,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -237417,7 +239863,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -237468,7 +239913,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: 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 4d63e129a..1deb02dae 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 @@ -5782,14 +5782,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -6922,14 +6914,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -7835,14 +7819,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -8313,14 +8289,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -10649,14 +10617,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -11821,14 +11781,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -12857,14 +12809,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -13596,14 +13540,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -36498,6 +36434,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -68673,6 +68616,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -107285,6 +107235,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "type": [ "object", @@ -109087,6 +109047,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -116207,7 +116176,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -131646,6 +131615,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -138136,7 +138112,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -139752,14 +139727,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -140907,14 +140874,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -209238,7 +209197,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209285,7 +209244,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209332,7 +209291,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209379,7 +209338,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209426,7 +209385,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210520,7 +210479,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210567,7 +210526,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210614,7 +210573,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210661,7 +210620,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210708,7 +210667,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211892,7 +211851,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211939,7 +211898,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211986,7 +211945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -212033,7 +211992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -212080,7 +212039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -213922,7 +213881,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -213969,7 +213928,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214016,7 +213975,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214063,7 +214022,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214110,7 +214069,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215229,7 +215188,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215276,7 +215235,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215323,7 +215282,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215370,7 +215329,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215417,7 +215376,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216597,7 +216556,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216644,7 +216603,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216691,7 +216650,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216738,7 +216697,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216785,7 +216744,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -217413,7 +217372,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -217594,61 +217553,59 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -381159,6 +381116,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -400107,14 +400071,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -411565,6 +411521,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -412492,6 +412455,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -413357,6 +413327,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -438601,6 +438578,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -439502,6 +439486,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -494094,6 +494085,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -565786,7 +565784,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -565859,7 +565857,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -565932,7 +565930,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -566005,7 +566003,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -566078,7 +566076,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567531,7 +567529,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567578,7 +567576,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567625,7 +567623,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567672,7 +567670,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567719,7 +567717,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568680,7 +568678,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568727,7 +568725,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568774,7 +568772,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568821,7 +568819,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568868,7 +568866,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570042,7 +570040,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570089,7 +570087,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570136,7 +570134,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570183,7 +570181,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570230,7 +570228,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572091,7 +572089,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572138,7 +572136,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572185,7 +572183,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572232,7 +572230,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572279,7 +572277,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573255,7 +573253,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573302,7 +573300,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573349,7 +573347,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573396,7 +573394,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573443,7 +573441,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574613,7 +574611,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574660,7 +574658,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574707,7 +574705,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574754,7 +574752,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574801,7 +574799,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -575437,7 +575435,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -575627,51 +575625,49 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -655661,14 +655657,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -709212,6 +709200,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -720131,6 +720126,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -731060,6 +731062,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -736693,14 +736702,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -768669,6 +768670,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -779584,6 +779592,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -803735,7 +803750,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -803790,7 +803804,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -808699,7 +808712,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -808754,7 +808766,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -813661,7 +813672,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -813716,7 +813726,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -818640,7 +818649,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -818695,7 +818703,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -819418,13 +819425,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -822217,13 +822217,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -825009,13 +825002,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -879296,13 +879282,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -899243,666 +899222,652 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "deployment_status": { - "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "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" - ] - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "description": { - "description": "The optional human-readable description added to the status.", - "type": "string" - }, - "environment": { - "type": "string" - }, - "environment_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "log_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "merge_queue_entry", - "workflow_job", - "merge_group", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "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": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "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" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { "type": "string", "enum": [ "read", @@ -956562,14 +956527,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -959677,14 +959634,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -962697,14 +962646,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -965717,14 +965658,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -968871,14 +968804,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -972032,14 +971957,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -977188,14 +977105,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -979470,411 +979379,9047 @@ "type": "string" }, "performed_via_github_app": { - "anyOf": [ - { - "type": "null" + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "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" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "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" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + }, + "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", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "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" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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", + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "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 + ] + }, + "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", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "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": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "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" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "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" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue 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" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "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" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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", + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "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 + ] + }, + "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", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "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": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "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" + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "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" + "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" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "issues": { - "type": "string" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "checks": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "metadata": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "contents": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "deployments": { - "type": "string" + "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" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 ] } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, "reactions": { @@ -980019,7 +988564,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -980034,6 +988580,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -981085,8 +989638,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "secret_scanning_alerts": { @@ -981131,13 +989683,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -983635,6 +992180,7 @@ }, "required": [ "action", + "changes", "issue", "comment", "repository", @@ -983661,11 +992207,11 @@ } } }, - "issue-comment-deleted": { + "issue-comment-pinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, @@ -983732,13 +992278,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment deleted event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "pinned" ] }, "comment": { @@ -984344,6 +992890,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -987970,11 +996523,11 @@ } } }, - "issue-comment-edited": { + "issue-comment-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, @@ -988041,33 +996594,15 @@ "content": { "application/json": { "schema": { - "title": "issue_comment edited event", + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "unpinned" ] }, - "changes": { - "description": "The changes to the comment.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "comment": { "title": "issue comment", "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", @@ -988671,6 +997206,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -989408,9 +997950,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -989665,8 +998205,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -990499,6 +999038,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -992271,7 +1000813,6 @@ }, "required": [ "action", - "changes", "issue", "comment", "repository", @@ -1028275,13 +1036816,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1031724,13 +1040258,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1035381,13 +1043908,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1038853,13 +1047373,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1042484,13 +1050997,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1045969,13 +1054475,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1049493,13 +1057992,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1052930,13 +1061422,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1056418,13 +1064903,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1058610,13 +1067088,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1062047,13 +1070518,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1065522,13 +1073986,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1068814,13 +1077271,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1071022,13 +1079472,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1074466,13 +1082909,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1078079,13 +1086515,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1081523,13 +1089952,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1085045,13 +1093467,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1088448,13 +1096863,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1091891,13 +1100299,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1431402,7 +1439803,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431449,7 +1439850,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431496,7 +1439897,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431543,7 +1439944,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431590,7 +1439991,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434702,7 +1443103,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434749,7 +1443150,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434796,7 +1443197,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434843,7 +1443244,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434890,7 +1443291,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438002,7 +1446403,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438049,7 +1446450,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438096,7 +1446497,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438143,7 +1446544,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438190,7 +1446591,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439076,7 +1447477,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439123,7 +1447524,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439170,7 +1447571,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439217,7 +1447618,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439264,7 +1447665,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439978,7 +1448379,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440025,7 +1448426,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440072,7 +1448473,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440119,7 +1448520,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440166,7 +1448567,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440883,7 +1449284,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440930,7 +1449331,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440977,7 +1449378,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1441024,7 +1449425,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1441071,7 +1449472,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", 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 24978b8c9..6a31ee6f0 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 @@ -2656,13 +2656,6 @@ paths: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access - token to manage team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access @@ -11963,6 +11956,9 @@ paths: - type: 'null' - *5 reactions: *73 + pin: + anyOf: + - type: 'null' required: - id - node_id @@ -27891,6 +27887,15 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled code_scanning_options: *49 code_scanning_default_setup: type: string @@ -28248,6 +28253,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -30136,7 +30149,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -32888,7 +32901,6 @@ paths: - subject_type: installation subject_id: 954453 subject_name: GitHub Actions - integration_id: 124345 total_request_count: 544665 rate_limited_request_count: 13 last_request_timestamp: '2024-09-18T15:43:03Z' @@ -43943,7 +43955,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -43979,7 +43992,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44015,7 +44029,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44051,7 +44066,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44087,7 +44103,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -45075,7 +45092,7 @@ paths: actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' - version_id: 2 actor: id: 2 @@ -45135,11 +45152,11 @@ paths: examples: default: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 21 name: super cool ruleset @@ -82017,6 +82034,9 @@ paths: - type: 'null' - *5 reactions: *73 + pin: + anyOf: + - type: 'null' required: - event - actor @@ -91573,11 +91593,11 @@ paths: examples: default: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 42 name: super cool ruleset @@ -110486,7 +110506,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -110537,7 +110556,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -110883,7 +110901,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -110934,7 +110951,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -111280,7 +111296,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -111331,7 +111346,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -111692,7 +111706,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -111743,7 +111756,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -112315,11 +112327,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113029,11 +113036,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113736,11 +113738,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -118434,11 +118431,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122319,502 +122311,492 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). - type: object - properties: - created_at: - type: string - 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 - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to - the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - - merge_group - - secret_scanning_alert_location - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - 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: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + 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 + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to + the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps are + first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - pull_request_review_thread + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -127447,6 +127429,9 @@ webhooks: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' user: title: User type: @@ -128258,11 +128243,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -128733,7 +128713,2700 @@ webhooks: - repository - organization - app - issue-comment-deleted: + issue-comment-deleted: + post: + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was deleted. + operationId: issue-comment/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issue_comment deleted event + type: object + properties: + action: + type: string + enum: + - deleted + comment: &715 + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + type: object + properties: + 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: Contents of the issue comment + type: string + created_at: + type: string + format: date-time + html_url: + type: string + format: uri + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + issue_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: *5 + 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 + updated_at: + type: string + format: date-time + url: + description: URL for the issue 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 + pin: + anyOf: + - type: 'null' + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + enterprise: *691 + installation: *692 + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + 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 + user_view_type: + type: string + 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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + 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 + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + 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 + repository_url: + type: string + format: uri + sub_issues_summary: *626 + issue_dependencies_summary: *627 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *215 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + 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 + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - '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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + 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 + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: *693 + repository: *694 + sender: *4 + required: + - action + - issue + - comment + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue_comment + supported-webhook-types: + - repository + - organization + - app + issue-comment-edited: + post: + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was edited. + operationId: issue-comment/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issue_comment edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: &739 + description: The changes to the comment. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + comment: *715 + enterprise: *691 + installation: *692 + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + 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 + user_view_type: + type: string + 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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + 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 + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + 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 + repository_url: + type: string + format: uri + sub_issues_summary: *626 + issue_dependencies_summary: *627 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *215 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + 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 + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - '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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + 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 + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: *693 + repository: *694 + sender: *4 + required: + - action + - changes + - issue + - comment + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue_comment + supported-webhook-types: + - repository + - organization + - app + issue-comment-pinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. @@ -128741,8 +131414,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was deleted. - operationId: issue-comment/deleted + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -128786,180 +131459,14 @@ webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &715 - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - 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: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: *5 - 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 - updated_at: - type: string - format: date-time - url: - description: URL for the issue 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 - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions + - pinned + comment: *715 enterprise: *691 installation: *692 issue: @@ -130159,7 +132666,7 @@ webhooks: - repository - organization - app - issue-comment-edited: + issue-comment-unpinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. @@ -130167,8 +132674,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was edited. - operationId: issue-comment/edited + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -130212,25 +132719,13 @@ webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &739 - description: The changes to the comment. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from + - unpinned comment: *715 enterprise: *691 installation: *692 @@ -130701,8 +133196,6 @@ webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: - string @@ -130886,7 +133379,6 @@ webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -131406,6 +133898,8 @@ webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -131416,7 +133910,6 @@ webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -132579,11 +135072,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -133602,11 +136090,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -134758,11 +137241,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135803,11 +138281,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136951,11 +139424,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137969,11 +140437,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139022,11 +141485,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -140034,11 +142492,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -141019,11 +143472,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142413,11 +144861,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -143425,11 +145868,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -144473,11 +146911,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -145455,11 +147888,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -147313,11 +149741,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: 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 4d63e129a..1deb02dae 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 @@ -5782,14 +5782,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -6922,14 +6914,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -7835,14 +7819,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -8313,14 +8289,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -10649,14 +10617,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -11821,14 +11781,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -12857,14 +12809,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -13596,14 +13540,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -36498,6 +36434,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -68673,6 +68616,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -107285,6 +107235,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "type": [ "object", @@ -109087,6 +109047,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -116207,7 +116176,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -131646,6 +131615,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -138136,7 +138112,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -139752,14 +139727,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -140907,14 +140874,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -209238,7 +209197,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209285,7 +209244,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209332,7 +209291,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209379,7 +209338,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -209426,7 +209385,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210520,7 +210479,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210567,7 +210526,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210614,7 +210573,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210661,7 +210620,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -210708,7 +210667,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211892,7 +211851,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211939,7 +211898,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -211986,7 +211945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -212033,7 +211992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -212080,7 +212039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -213922,7 +213881,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -213969,7 +213928,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214016,7 +213975,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214063,7 +214022,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -214110,7 +214069,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215229,7 +215188,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215276,7 +215235,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215323,7 +215282,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215370,7 +215329,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -215417,7 +215376,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216597,7 +216556,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216644,7 +216603,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216691,7 +216650,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216738,7 +216697,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -216785,7 +216744,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -217413,7 +217372,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -217594,61 +217553,59 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -381159,6 +381116,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -400107,14 +400071,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -411565,6 +411521,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -412492,6 +412455,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -413357,6 +413327,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -438601,6 +438578,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -439502,6 +439486,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -494094,6 +494085,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -565786,7 +565784,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -565859,7 +565857,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -565932,7 +565930,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -566005,7 +566003,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -566078,7 +566076,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567531,7 +567529,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567578,7 +567576,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567625,7 +567623,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567672,7 +567670,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -567719,7 +567717,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568680,7 +568678,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568727,7 +568725,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568774,7 +568772,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568821,7 +568819,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -568868,7 +568866,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570042,7 +570040,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570089,7 +570087,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570136,7 +570134,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570183,7 +570181,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -570230,7 +570228,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572091,7 +572089,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572138,7 +572136,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572185,7 +572183,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572232,7 +572230,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -572279,7 +572277,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573255,7 +573253,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573302,7 +573300,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573349,7 +573347,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573396,7 +573394,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -573443,7 +573441,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574613,7 +574611,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574660,7 +574658,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574707,7 +574705,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574754,7 +574752,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -574801,7 +574799,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -575437,7 +575435,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -575627,51 +575625,49 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -655661,14 +655657,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -709212,6 +709200,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -720131,6 +720126,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -731060,6 +731062,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -736693,14 +736702,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -768669,6 +768670,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -779584,6 +779592,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -803735,7 +803750,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -803790,7 +803804,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -808699,7 +808712,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -808754,7 +808766,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -813661,7 +813672,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -813716,7 +813726,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -818640,7 +818649,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -818695,7 +818703,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -819418,13 +819425,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -822217,13 +822217,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -825009,13 +825002,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -879296,13 +879282,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -899243,666 +899222,652 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "deployment_status": { - "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "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" - ] - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "description": { - "description": "The optional human-readable description added to the status.", - "type": "string" - }, - "environment": { - "type": "string" - }, - "environment_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "log_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "merge_queue_entry", - "workflow_job", - "merge_group", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "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": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "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" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { "type": "string", "enum": [ "read", @@ -956562,14 +956527,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -959677,14 +959634,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -962697,14 +962646,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -965717,14 +965658,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -968871,14 +968804,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -972032,14 +971957,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -977188,14 +977105,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -979470,411 +979379,9047 @@ "type": "string" }, "performed_via_github_app": { - "anyOf": [ - { - "type": "null" + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "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" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "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" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + }, + "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", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "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" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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", + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "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 + ] + }, + "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", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "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": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "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" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "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" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue 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" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "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" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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", + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "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 + ] + }, + "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", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "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": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "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" + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "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" + "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" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "issues": { - "type": "string" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "checks": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "metadata": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "contents": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "deployments": { - "type": "string" + "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" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 ] } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, "reactions": { @@ -980019,7 +988564,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -980034,6 +988580,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -981085,8 +989638,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "secret_scanning_alerts": { @@ -981131,13 +989683,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -983635,6 +992180,7 @@ }, "required": [ "action", + "changes", "issue", "comment", "repository", @@ -983661,11 +992207,11 @@ } } }, - "issue-comment-deleted": { + "issue-comment-pinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, @@ -983732,13 +992278,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment deleted event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "pinned" ] }, "comment": { @@ -984344,6 +992890,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -987970,11 +996523,11 @@ } } }, - "issue-comment-edited": { + "issue-comment-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, @@ -988041,33 +996594,15 @@ "content": { "application/json": { "schema": { - "title": "issue_comment edited event", + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "unpinned" ] }, - "changes": { - "description": "The changes to the comment.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "comment": { "title": "issue comment", "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", @@ -988671,6 +997206,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -989408,9 +997950,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -989665,8 +998205,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -990499,6 +999038,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -992271,7 +1000813,6 @@ }, "required": [ "action", - "changes", "issue", "comment", "repository", @@ -1028275,13 +1036816,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1031724,13 +1040258,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1035381,13 +1043908,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1038853,13 +1047373,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1042484,13 +1050997,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1045969,13 +1054475,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1049493,13 +1057992,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1052930,13 +1061422,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1056418,13 +1064903,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1058610,13 +1067088,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1062047,13 +1070518,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1065522,13 +1073986,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1068814,13 +1077271,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1071022,13 +1079472,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1074466,13 +1082909,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1078079,13 +1086515,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1081523,13 +1089952,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1085045,13 +1093467,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1088448,13 +1096863,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1091891,13 +1100299,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1431402,7 +1439803,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431449,7 +1439850,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431496,7 +1439897,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431543,7 +1439944,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1431590,7 +1439991,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434702,7 +1443103,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434749,7 +1443150,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434796,7 +1443197,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434843,7 +1443244,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1434890,7 +1443291,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438002,7 +1446403,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438049,7 +1446450,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438096,7 +1446497,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438143,7 +1446544,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1438190,7 +1446591,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439076,7 +1447477,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439123,7 +1447524,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439170,7 +1447571,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439217,7 +1447618,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439264,7 +1447665,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1439978,7 +1448379,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440025,7 +1448426,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440072,7 +1448473,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440119,7 +1448520,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440166,7 +1448567,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440883,7 +1449284,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440930,7 +1449331,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1440977,7 +1449378,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1441024,7 +1449425,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1441071,7 +1449472,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", 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 24978b8c9..6a31ee6f0 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 @@ -2656,13 +2656,6 @@ paths: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access - token to manage team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access @@ -11963,6 +11956,9 @@ paths: - type: 'null' - *5 reactions: *73 + pin: + anyOf: + - type: 'null' required: - id - node_id @@ -27891,6 +27887,15 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled code_scanning_options: *49 code_scanning_default_setup: type: string @@ -28248,6 +28253,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -30136,7 +30149,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -32888,7 +32901,6 @@ paths: - subject_type: installation subject_id: 954453 subject_name: GitHub Actions - integration_id: 124345 total_request_count: 544665 rate_limited_request_count: 13 last_request_timestamp: '2024-09-18T15:43:03Z' @@ -43943,7 +43955,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -43979,7 +43992,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44015,7 +44029,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44051,7 +44066,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -44087,7 +44103,8 @@ paths: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring + it. negate: type: boolean description: If true, the rule will fail if the @@ -45075,7 +45092,7 @@ paths: actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' - version_id: 2 actor: id: 2 @@ -45135,11 +45152,11 @@ paths: examples: default: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 21 name: super cool ruleset @@ -82017,6 +82034,9 @@ paths: - type: 'null' - *5 reactions: *73 + pin: + anyOf: + - type: 'null' required: - event - actor @@ -91573,11 +91593,11 @@ paths: examples: default: value: - - version_id: 3 + version_id: 3 actor: id: 1 type: User - updated_at: 2024-010-23T16:29:47Z + updated_at: '2024-10-23T16:29:47Z' state: id: 42 name: super cool ruleset @@ -110486,7 +110506,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -110537,7 +110556,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -110883,7 +110901,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -110934,7 +110951,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -111280,7 +111296,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -111331,7 +111346,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -111692,7 +111706,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -111743,7 +111756,6 @@ webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -112315,11 +112327,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113029,11 +113036,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -113736,11 +113738,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -118434,11 +118431,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122319,502 +122311,492 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). - type: object - properties: - created_at: - type: string - 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 - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to - the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - - merge_group - - secret_scanning_alert_location - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - 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: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + 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 + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to + the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps are + first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - pull_request_review_thread + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -127447,6 +127429,9 @@ webhooks: description: URL for the issue comment type: string format: uri + pin: + anyOf: + - type: 'null' user: title: User type: @@ -128258,11 +128243,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -128733,7 +128713,2700 @@ webhooks: - repository - organization - app - issue-comment-deleted: + issue-comment-deleted: + post: + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was deleted. + operationId: issue-comment/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issue_comment deleted event + type: object + properties: + action: + type: string + enum: + - deleted + comment: &715 + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + type: object + properties: + 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: Contents of the issue comment + type: string + created_at: + type: string + format: date-time + html_url: + type: string + format: uri + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + issue_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: *5 + 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 + updated_at: + type: string + format: date-time + url: + description: URL for the issue 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 + pin: + anyOf: + - type: 'null' + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + enterprise: *691 + installation: *692 + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + 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 + user_view_type: + type: string + 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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + 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 + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + 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 + repository_url: + type: string + format: uri + sub_issues_summary: *626 + issue_dependencies_summary: *627 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *215 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + 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 + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - '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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + 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 + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string + required: + - labels + - state + - locked + - assignee + organization: *693 + repository: *694 + sender: *4 + required: + - action + - issue + - comment + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue_comment + supported-webhook-types: + - repository + - organization + - app + issue-comment-edited: + post: + summary: |- + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A comment on an issue or pull request was edited. + operationId: issue-comment/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: issue_comment edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: &739 + description: The changes to the comment. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + comment: *715 + enterprise: *691 + installation: *692 + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + 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 + user_view_type: + type: string + 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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + 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 + labels_url: + type: string + format: uri-template + locked: + type: boolean + 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 + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They + can be installed directly on organizations and user accounts + and granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps + are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + 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: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + 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 + repository_url: + type: string + format: uri + sub_issues_summary: *626 + issue_dependencies_summary: *627 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *215 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + 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 + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - '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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + 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 + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: *693 + repository: *694 + sender: *4 + required: + - action + - changes + - issue + - comment + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: issue_comment + supported-webhook-types: + - repository + - organization + - app + issue-comment-pinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. @@ -128741,8 +131414,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was deleted. - operationId: issue-comment/deleted + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -128786,180 +131459,14 @@ webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &715 - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - 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: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: *5 - 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 - updated_at: - type: string - format: date-time - url: - description: URL for the issue 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 - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions + - pinned + comment: *715 enterprise: *691 installation: *692 issue: @@ -130159,7 +132666,7 @@ webhooks: - repository - organization - app - issue-comment-edited: + issue-comment-unpinned: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[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 issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. @@ -130167,8 +132674,8 @@ webhooks: For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was edited. - operationId: issue-comment/edited + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -130212,25 +132719,13 @@ webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &739 - description: The changes to the comment. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from + - unpinned comment: *715 enterprise: *691 installation: *692 @@ -130701,8 +133196,6 @@ webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: - string @@ -130886,7 +133379,6 @@ webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -131406,6 +133898,8 @@ webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -131416,7 +133910,6 @@ webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -132579,11 +135072,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -133602,11 +136090,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -134758,11 +137241,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135803,11 +138281,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136951,11 +139424,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137969,11 +140437,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139022,11 +141485,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -140034,11 +142492,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -141019,11 +143472,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142413,11 +144861,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -143425,11 +145868,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -144473,11 +146911,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -145455,11 +147888,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -147313,11 +149741,6 @@ webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: 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 93e1fdf2a..f8e248403 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -5798,14 +5798,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -6954,14 +6946,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -7883,14 +7867,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -8377,14 +8353,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -10729,14 +10697,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -11917,14 +11877,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -12969,14 +12921,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -13724,14 +13668,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -31288,14 +31224,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -32175,9 +32103,1100 @@ "write" ] }, - "team_discussions": { + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "enterprise_organization_installations": { + "type": "string", + "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_organization_installation_repositories": { "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "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" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "repository_selection": "selected", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + } + } + } + } + }, + "201": { + "description": "A GitHub App installation.", + "content": { + "application/json": { + "schema": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "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" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" @@ -32584,9 +33603,406 @@ } } } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_id": { + "type": "string", + "description": "The Client ID of the GitHub App to install." + }, + "repository_selection": { + "type": "string", + "description": "The repository selection for the GitHub App. Must be one of:\n* `all` - the installation can access all repositories in the organization.\n* `selected` - the installation can access only the listed repositories.\n* `none` - no repository permissions are requested. Only use when the app does not request repository permissions.", + "enum": [ + "all", + "selected", + "none" + ] + }, + "repositories": { + "type": "array", + "description": "The names of the repositories to which the installation will be granted access. This is the simple name of the repository, not the full name (e.g., `hello-world` not `octocat/hello-world`). This is only required when `repository_selection` is `selected`.", + "items": { + "type": "string" + }, + "maxItems": 50 + } + }, + "required": [ + "client_id", + "repository_selection" + ] + }, + "examples": { + "default": { + "summary": "Example of installing a GitHub App on an organization and granting access to all of its repositories.", + "value": { + "client_id": "Iv2abc123aabbcc", + "repository_selection": "all" + } + }, + "repository_selection_selected": { + "value": { + "client_id": "Iv2abc123aabbcc", + "repository_selection": "selected", + "repositories": [ + "hello-world", + "hello-world-2" + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "organization-installations" + } + } + }, + "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}": { + "delete": { + "summary": "Uninstall a GitHub App from an enterprise-owned organization", + "description": "Uninstall a GitHub App from an organization. Any app installed on the organization can be removed.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", + "tags": [ + "apps" + ], + "operationId": "enterprise-apps/delete-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "201": { - "description": "A GitHub App installation.", + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "responses": { + "204": { + "description": "An empty response indicates that the installation was successfully removed." + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "organization-installations" + } + } + }, + "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories": { + "get": { + "summary": "Get the repositories accessible to a given GitHub App installation", + "description": "Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", + "tags": [ + "apps" + ], + "operationId": "enterprise-apps/organization-installation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "A list of repositories owned by the enterprise organization to which the installation has access.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Accessible Repository", + "description": "A repository that may be made accessible to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + } + }, + "required": [ + "full_name", + "id", + "name" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "name": "Hello World", + "full_name": "octocat/Hello-World" + }, + { + "id": 2, + "login": "Goodbye World", + "full_name": "octocat/Goodbye-World" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "organization-installations" + } + }, + "patch": { + "summary": "Toggle installation repository access between selected and all repositories", + "description": "Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", + "tags": [ + "apps" + ], + "operationId": "enterprise-apps/change-installation-repository-access-selection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_selection": { + "type": "string", + "description": "One of either 'all' or 'selected'", + "enum": [ + "all", + "selected" + ] + }, + "repositories": { + "type": "array", + "description": "The repository names to add to the installation. Only required when repository_selection is 'selected'", + "items": { + "type": "string" + }, + "maxItems": 50 + } + }, + "required": [ + "repository_selection" + ] + }, + "examples": { + "default": { + "summary": "Change the repositories accessible to a GitHub App from 'all repositories' to a specified subset.", + "value": { + "repository_selection": "selected", + "repositories": [ + "hello-world", + "hello-world-2" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "The GitHub App installation that was updated.", "content": { "application/json": { "schema": { @@ -33282,1518 +34698,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] - }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - }, - "enterprise_custom_properties_for_organizations": { - "type": "string", - "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "enterprise_organization_installations": { - "type": "string", - "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", - "enum": [ - "read", - "write" - ] - }, - "enterprise_organization_installation_repositories": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "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" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "account": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/github/settings/installations/1", - "app_id": 1, - "target_id": 1, - "target_type": "Organization", - "permissions": { - "checks": "write", - "metadata": "read", - "contents": "read" - }, - "events": [ - "push", - "pull_request" - ], - "single_file_name": "config.yaml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "repository_selection": "selected", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - } - } - } - } - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "client_id": { - "type": "string", - "description": "The Client ID of the GitHub App to install." - }, - "repository_selection": { - "type": "string", - "description": "The repository selection for the GitHub App. Must be one of:\n* `all` - the installation can access all repositories in the organization.\n* `selected` - the installation can access only the listed repositories.\n* `none` - no repository permissions are requested. Only use when the app does not request repository permissions.", - "enum": [ - "all", - "selected", - "none" - ] - }, - "repositories": { - "type": "array", - "description": "The names of the repositories to which the installation will be granted access. This is the simple name of the repository, not the full name (e.g., `hello-world` not `octocat/hello-world`). This is only required when `repository_selection` is `selected`.", - "items": { - "type": "string" - }, - "maxItems": 50 - } - }, - "required": [ - "client_id", - "repository_selection" - ] - }, - "examples": { - "default": { - "summary": "Example of installing a GitHub App on an organization and granting access to all of its repositories.", - "value": { - "client_id": "Iv2abc123aabbcc", - "repository_selection": "all" - } - }, - "repository_selection_selected": { - "value": { - "client_id": "Iv2abc123aabbcc", - "repository_selection": "selected", - "repositories": [ - "hello-world", - "hello-world-2" - ] - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "organization-installations" - } - } - }, - "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}": { - "delete": { - "summary": "Uninstall a GitHub App from an enterprise-owned organization", - "description": "Uninstall a GitHub App from an organization. Any app installed on the organization can be removed.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", - "tags": [ - "apps" - ], - "operationId": "enterprise-apps/delete-installation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "examples": { - "default": { - "value": 1 - } - } - } - ], - "responses": { - "204": { - "description": "An empty response indicates that the installation was successfully removed." - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "organization-installations" - } - } - }, - "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories": { - "get": { - "summary": "Get the repositories accessible to a given GitHub App installation", - "description": "Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", - "tags": [ - "apps" - ], - "operationId": "enterprise-apps/organization-installation-repositories", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "examples": { - "default": { - "value": 1 - } - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "A list of repositories owned by the enterprise organization to which the installation has access.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Accessible Repository", - "description": "A repository that may be made accessible to a GitHub App.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - } - }, - "required": [ - "full_name", - "id", - "name" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "name": "Hello World", - "full_name": "octocat/Hello-World" - }, - { - "id": 2, - "login": "Goodbye World", - "full_name": "octocat/Goodbye-World" - } - ] - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "organization-installations" - } - }, - "patch": { - "summary": "Toggle installation repository access between selected and all repositories", - "description": "Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided.\n\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.", - "tags": [ - "apps" - ], - "operationId": "enterprise-apps/change-installation-repository-access-selection", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "examples": { - "default": { - "value": 1 - } - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repository_selection": { - "type": "string", - "description": "One of either 'all' or 'selected'", - "enum": [ - "all", - "selected" - ] - }, - "repositories": { - "type": "array", - "description": "The repository names to add to the installation. Only required when repository_selection is 'selected'", - "items": { - "type": "string" - }, - "maxItems": 50 - } - }, - "required": [ - "repository_selection" - ] - }, - "examples": { - "default": { - "summary": "Change the repositories accessible to a GitHub App from 'all repositories' to a specified subset.", - "value": { - "repository_selection": "selected", - "repositories": [ - "hello-world", - "hello-world-2" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "The GitHub App installation that was updated.", - "content": { - "application/json": { - "schema": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "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" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/app/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "Iv1.ab1112223334445c" - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "artifact_metadata": { - "type": "string", - "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", - "enum": [ - "read", - "write" - ] - }, - "attestations": { - "type": "string", - "description": "The level of permission to create and retrieve the access token for repository attestations.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "description": "The level of permission to grant the access token for discussions and related comments and labels.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "merge_queues": { - "type": "string", - "description": "The level of permission to grant the access token to manage the merge queues for a repository.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "custom_properties_for_organizations": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -51724,6 +51628,1139 @@ } } }, + "/enterprises/{enterprise}/installation": { + "get": { + "summary": "Get an enterprise installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find its installation on a particular enterprise.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-enterprise-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "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" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "enterprise_organization_installations": { + "type": "string", + "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_organization_installation_repositories": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "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" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "account": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "client_id": "Iv1.ab1112223334445c", + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, "/enterprises/{enterprise}/license-sync-status": { "get": { "summary": "Get a license sync status", @@ -58117,7 +59154,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58164,7 +59201,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58211,7 +59248,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58258,7 +59295,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58305,7 +59342,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58621,7 +59658,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -58642,7 +59679,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -59475,7 +60512,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59522,7 +60559,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59569,7 +60606,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59616,7 +60653,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59663,7 +60700,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59984,7 +61021,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -60002,7 +61039,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -60939,7 +61976,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -60986,7 +62023,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61033,7 +62070,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61080,7 +62117,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61127,7 +62164,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -61448,7 +62485,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -61466,7 +62503,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -62772,7 +63809,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62819,7 +63856,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62866,7 +63903,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62913,7 +63950,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -62960,7 +63997,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -63272,7 +64309,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -63293,7 +64330,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -64126,7 +65163,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64173,7 +65210,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64220,7 +65257,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64267,7 +65304,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64314,7 +65351,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -64635,7 +65672,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -64653,7 +65690,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -64928,7 +65965,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -65109,41 +66146,39 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "repository", - "source_type": "Enterprise", - "source": "my-enterprise", - "enforcement": "active", - "conditions": { - "organization_name": { - "include": [ - "important_organization" - ] - }, - "repository_name": { - "include": [ - "~ALL" - ] - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] }, - "rules": [ - { - "type": "repository_delete" - } - ] - } + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] } - ] + } } } } @@ -84848,6 +85883,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -117023,6 +118065,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -155547,6 +156596,16 @@ ], "default": "disabled" }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, "code_scanning_options": { "type": [ "object", @@ -157349,6 +158408,15 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -164493,7 +165561,7 @@ }, "cli": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "description": "The organization policy for allowing or disallowing Copilot CLI.", "enum": [ "enabled", "disabled", @@ -185345,6 +186413,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -192289,7 +193364,6 @@ "subject_type": "installation", "subject_id": 954453, "subject_name": "GitHub Actions", - "integration_id": 124345, "total_request_count": 544665, "rate_limited_request_count": 13, "last_request_timestamp": "2024-09-18T15:43:03Z", @@ -193905,14 +194979,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -195076,14 +196142,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -264833,7 +265891,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -264880,7 +265938,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -264927,7 +265985,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -264974,7 +266032,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -265021,7 +266079,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266116,7 +267174,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266163,7 +267221,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266210,7 +267268,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266257,7 +267315,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -266304,7 +267362,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267489,7 +268547,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267536,7 +268594,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267583,7 +268641,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267630,7 +268688,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -267677,7 +268735,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269520,7 +270578,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269567,7 +270625,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269614,7 +270672,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269661,7 +270719,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -269708,7 +270766,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270828,7 +271886,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270875,7 +271933,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270922,7 +271980,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -270969,7 +272027,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -271016,7 +272074,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272197,7 +273255,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272244,7 +273302,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272291,7 +273349,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272338,7 +273396,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -272385,7 +273443,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -273013,7 +274071,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -273194,61 +274252,59 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" - }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -444268,6 +445324,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -463240,14 +464303,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -474738,6 +475793,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -475665,6 +476727,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -476530,6 +477599,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -501774,6 +502850,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -502675,6 +503758,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -557267,6 +558357,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -629102,7 +630199,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629175,7 +630272,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629248,7 +630345,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629321,7 +630418,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -629394,7 +630491,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630848,7 +631945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630895,7 +631992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630942,7 +632039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -630989,7 +632086,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -631036,7 +632133,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -631998,7 +633095,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632045,7 +633142,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632092,7 +633189,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632139,7 +633236,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -632186,7 +633283,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633361,7 +634458,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633408,7 +634505,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633455,7 +634552,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633502,7 +634599,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -633549,7 +634646,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635411,7 +636508,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635458,7 +636555,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635505,7 +636602,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635552,7 +636649,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -635599,7 +636696,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636576,7 +637673,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636623,7 +637720,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636670,7 +637767,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636717,7 +637814,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -636764,7 +637861,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -637935,7 +639032,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -637982,7 +639079,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638029,7 +639126,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638076,7 +639173,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638123,7 +639220,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -638759,7 +639856,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -638949,51 +640046,49 @@ }, "examples": { "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 42, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Repository", - "source": "monalisa/my-repo", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } - ] - } + } + ] } - ] + } } } } @@ -731121,14 +732216,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -784772,6 +785859,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -795691,6 +796785,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -806620,6 +807721,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -812253,14 +813361,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -844269,6 +845369,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -855184,6 +856291,13 @@ "eyes", "rocket" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -890316,7 +891430,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -890371,7 +891484,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -895292,7 +896404,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -895347,7 +896458,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -900266,7 +901376,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -900321,7 +901430,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -905257,7 +906365,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -905312,7 +906419,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -906035,13 +907141,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -908834,13 +909933,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -911626,13 +912718,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -965913,13 +966998,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -985860,666 +986938,652 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "enum": [ - "read", - "write" - ] - } - } - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at" - ] - }, - "production_environment": { - "type": "boolean" - }, - "ref": { - "type": "string" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "statuses_url": { - "type": "string", - "format": "uri" - }, - "task": { - "type": "string" - }, - "transient_environment": { - "type": "boolean" - }, - "updated_at": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "id", - "node_id", - "sha", - "ref", - "task", - "payload", - "original_environment", - "environment", - "description", - "creator", - "created_at", - "updated_at", - "statuses_url", - "repository_url" - ] - }, - "deployment_status": { - "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses).", - "type": "object", - "properties": { - "created_at": { - "type": "string" - }, - "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" - ] - }, - "deployment_url": { - "type": "string", - "format": "uri" - }, - "description": { - "description": "The optional human-readable description added to the status.", - "type": "string" - }, - "environment": { - "type": "string" - }, - "environment_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "log_url": { - "type": "string", - "format": "uri" - }, - "node_id": { - "type": "string" - }, - "performed_via_github_app": { - "title": "App", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events": { - "description": "The list of events for the GitHub app", - "type": "array", - "items": { - "type": "string", - "enum": [ - "branch_protection_rule", - "check_run", - "check_suite", - "code_scanning_alert", - "commit_comment", - "content_reference", - "create", - "delete", - "deployment", - "deployment_review", - "deployment_status", - "deploy_key", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issues", - "issue_comment", - "label", - "member", - "membership", - "milestone", - "organization", - "org_block", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "push", - "registry_package", - "release", - "repository", - "repository_dispatch", - "secret_scanning_alert", - "star", - "status", - "team", - "team_add", - "watch", - "workflow_dispatch", - "workflow_run", - "pull_request_review_thread", - "merge_queue_entry", - "workflow_job", - "merge_group", - "secret_scanning_alert_location" - ] - } - }, - "external_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": [ - "integer", - "null" - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "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": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "actions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "content_references": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "emails": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "keys": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "members": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "security_scanning_alert": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "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" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { "type": "string", "enum": [ "read", @@ -1079215,14 +1080279,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1082346,14 +1083402,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1085382,14 +1086430,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1088418,14 +1089458,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1091588,14 +1092620,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1094765,14 +1095789,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1099937,14 +1100953,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", @@ -1102235,411 +1103243,9047 @@ "type": "string" }, "performed_via_github_app": { - "anyOf": [ - { - "type": "null" + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "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" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "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" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + }, + "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", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "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" + ] + }, + "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" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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", + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "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 + ] + }, + "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", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "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": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "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" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "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" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue 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" + ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "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" + ] + }, + "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" + ] + }, + "issue": { + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "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", + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "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" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "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" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": [ + "integer", + "null" + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "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": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "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" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": [ + "string", + "null" + ] + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "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", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": [ + "string", + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": [ + "object", + "null" + ] + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "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" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": [ + "object", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": [ + "object", + "null" + ] + }, + "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" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "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 + ] + }, + "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", + "issue", + "comment", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "issue_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "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": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] }, - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "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" + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "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" + "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" ] }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "permissions": { - "description": "The set of permissions for the GitHub app", + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "issues": { - "type": "string" + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "checks": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] }, - "metadata": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" }, - "contents": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] }, - "deployments": { - "type": "string" + "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" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 ] } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, "reactions": { @@ -1102784,7 +1112428,8 @@ "enum": [ "Bot", "User", - "Organization" + "Organization", + "Mannequin" ] }, "url": { @@ -1102799,6 +1112444,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -1103850,8 +1113502,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "secret_scanning_alerts": { @@ -1103896,13 +1113547,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1106400,6 +1116044,7 @@ }, "required": [ "action", + "changes", "issue", "comment", "repository", @@ -1106426,11 +1116071,11 @@ } } }, - "issue-comment-deleted": { + "issue-comment-pinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, @@ -1106497,13 +1116142,13 @@ "content": { "application/json": { "schema": { - "title": "issue_comment deleted event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "deleted" + "pinned" ] }, "comment": { @@ -1107109,6 +1116754,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -1110735,11 +1120387,11 @@ } } }, - "issue-comment-edited": { + "issue-comment-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, @@ -1110806,33 +1120458,15 @@ "content": { "application/json": { "schema": { - "title": "issue_comment edited event", + "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "edited" + "unpinned" ] }, - "changes": { - "description": "The changes to the comment.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, "comment": { "title": "issue comment", "description": "The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself.", @@ -1111436,6 +1121070,13 @@ "login", "id" ] + }, + "pin": { + "anyOf": [ + { + "type": "null" + } + ] } }, "required": [ @@ -1112173,9 +1121814,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -1112430,8 +1122069,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -1113264,6 +1122902,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -1115036,7 +1124677,6 @@ }, "required": [ "action", - "changes", "issue", "comment", "repository", @@ -1151040,13 +1160680,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1154489,13 +1164122,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1158146,13 +1167772,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1161618,13 +1171237,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1165249,13 +1174861,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1168734,13 +1178339,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1172258,13 +1181856,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1175695,13 +1185286,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1179183,13 +1188767,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1181375,13 +1190952,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1184812,13 +1194382,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1188287,13 +1197850,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1191579,13 +1201135,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1193787,13 +1203336,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1197231,13 +1206773,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1200844,13 +1210379,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1204288,13 +1213816,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1207810,13 +1217331,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1211213,13 +1220727,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1214656,13 +1224163,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1556104,7 +1565604,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556151,7 +1565651,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556198,7 +1565698,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556245,7 +1565745,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1556292,7 +1565792,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559405,7 +1568905,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559452,7 +1568952,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559499,7 +1568999,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559546,7 +1569046,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1559593,7 +1569093,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562706,7 +1572206,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562753,7 +1572253,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562800,7 +1572300,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562847,7 +1572347,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1562894,7 +1572394,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563780,7 +1573280,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563827,7 +1573327,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563874,7 +1573374,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563921,7 +1573421,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1563968,7 +1573468,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564682,7 +1574182,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564729,7 +1574229,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564776,7 +1574276,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564823,7 +1574323,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1564870,7 +1574370,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565587,7 +1575087,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565634,7 +1575134,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565681,7 +1575181,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1565728,7 +1575228,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "desc{"code":"deadline_exceeded","msg":"operation timed out"}