diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 4965325bc..78fb8530e 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -15784,6 +15784,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" }, @@ -16266,6 +16276,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", @@ -82310,6 +82329,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.", @@ -101482,14 +101687,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.", @@ -111659,7 +111856,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", @@ -117358,7 +117555,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -117405,7 +117602,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -117452,7 +117649,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -117499,7 +117696,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -117546,7 +117743,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -139877,13 +140074,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -141263,13 +141453,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -150508,13 +150691,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -151331,13 +151507,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -152147,13 +152316,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -156164,13 +156326,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -160777,13 +160932,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -161416,13 +161564,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -165879,13 +166020,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -167450,13 +167584,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -169030,13 +169157,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -169664,244 +169784,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" @@ -169910,7 +169804,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", @@ -170480,10 +170374,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -170730,8 +170621,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -170962,12 +170852,3383 @@ "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", @@ -172271,13 +175532,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -173539,13 +176793,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -174778,13 +178025,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -176021,13 +179261,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -177301,13 +180534,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178534,13 +181760,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -179737,13 +182956,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -181542,13 +184754,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -182849,13 +186054,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -184048,13 +187246,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -186064,13 +189255,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -285237,7 +288421,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", @@ -288791,7 +291974,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -288812,61 +291995,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": [ @@ -302588,51 +305769,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": [ @@ -307919,7 +311098,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -307974,7 +311152,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308245,7 +311422,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308300,7 +311476,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308558,7 +311733,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308613,7 +311787,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308899,7 +312072,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308954,7 +312126,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index bc76ee358..b140220fb 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -11424,6 +11424,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: @@ -11800,6 +11809,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 @@ -59514,284 +59531,18 @@ x-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 @@ -59833,7 +59584,7 @@ x-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 @@ -59841,23 +59592,23 @@ x-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 @@ -59899,7 +59650,7 @@ x-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 @@ -59907,23 +59658,23 @@ x-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 @@ -59965,7 +59716,7 @@ x-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 @@ -59973,23 +59724,24 @@ x-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 @@ -60031,7 +59783,7 @@ x-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 @@ -60039,12 +59791,145 @@ x-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. @@ -60052,8 +59937,8 @@ x-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: @@ -60097,7 +59982,7 @@ x-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 @@ -60110,7 +59995,7 @@ x-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. @@ -60118,8 +60003,8 @@ x-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: @@ -60163,7 +60048,7 @@ x-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 @@ -60176,7 +60061,7 @@ x-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. @@ -60184,9 +60069,8 @@ x-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: @@ -60230,7 +60114,7 @@ x-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 @@ -60243,7 +60127,7 @@ x-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. @@ -60251,8 +60135,8 @@ x-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: @@ -60296,7 +60180,7 @@ x-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 @@ -60309,7 +60193,7 @@ x-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. @@ -60317,9 +60201,8 @@ x-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: @@ -60363,7 +60246,7 @@ x-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 @@ -60376,7 +60259,7 @@ x-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. @@ -60384,9 +60267,8 @@ x-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: @@ -60430,7 +60312,7 @@ x-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 @@ -60443,7 +60325,7 @@ x-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. @@ -60451,8 +60333,9 @@ x-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: @@ -60496,7 +60379,7 @@ x-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 @@ -60509,7 +60392,7 @@ x-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. @@ -60517,9 +60400,8 @@ x-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: @@ -60563,7 +60445,7 @@ x-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 @@ -60576,7 +60458,7 @@ x-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. @@ -60584,8 +60466,275 @@ x-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: @@ -73318,13 +73467,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 @@ -81473,7 +81615,7 @@ components: cli: type: string description: The organization policy for allowing or disallowing Copilot - in the CLI. + CLI. enum: - enabled - disabled @@ -86050,7 +86192,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. @@ -86084,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. @@ -86118,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. @@ -86152,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. @@ -86186,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. @@ -103196,11 +103338,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -104241,11 +104378,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -111285,11 +111417,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -111914,11 +112041,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -112536,11 +112658,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -115598,11 +115715,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -118875,11 +118987,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -119358,11 +119465,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122576,11 +122678,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -123744,11 +123841,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -124919,11 +125011,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125375,182 +125462,23 @@ components: - 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 + webhook-issue-comment-pinned: + title: issue_comment pinned 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) @@ -125998,9 +125926,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - reminder - - pull_request_review_thread external_url: type: string nullable: true @@ -126180,7 +126105,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -126345,10 +126269,6 @@ 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 @@ -126472,8 +126392,75 @@ components: type: string nullable: true assignee: + title: User type: object nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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: @@ -126502,8 +126489,37 @@ components: labels: type: array items: + title: Label type: object - nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + 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: @@ -126544,10 +126560,11 @@ components: repository_url: type: string state: + description: State of the issue; either 'open' or 'closed' type: string enum: - - closed - open + - closed timeline_url: type: string title: @@ -126599,8 +126616,10 @@ components: user_view_type: type: string required: + - labels - state - - closed_at + - locked + - assignee organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -126610,107 +126629,42 @@ components: 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" 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 - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: title: User type: object nullable: true @@ -126771,6 +126725,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -126779,101 +126734,9 @@ components: 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 - nullable: true - closed_at: - type: string - nullable: true - 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 - nullable: true - 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 - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: + assignees: + type: array + items: title: User type: object nullable: true @@ -126934,6 +126797,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -126942,595 +126806,990 @@ components: required: - login - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - 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 - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - 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 - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User + 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 + nullable: true + closed_at: + type: string + nullable: true + 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 - nullable: true properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - 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: + description: URL for the label 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: + - 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: type: string enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - 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 - nullable: true - 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 - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 + - 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: @@ -127540,16 +127799,1249 @@ components: required: - action - issue + - comment - repository - sender - webhook-issues-demilestoned: - title: issues demilestoned event + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event type: object properties: action: type: string enum: - - demilestoned + - 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + type: object + nullable: true + assignees: + type: array + items: + type: object + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + labels_url: + type: string + locked: + type: boolean + milestone: + type: object + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: @@ -127559,28 +129051,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 - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user properties: active_lock_reason: type: string @@ -127595,9 +129065,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -127655,19 +129122,20 @@ components: - 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 nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -127725,10 +129193,14 @@ 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. @@ -127774,15 +129246,6 @@ components: items: title: Label type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -127804,6 +129267,14 @@ 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 @@ -127814,23 +129285,6 @@ components: description: A collection of related issues and pull requests. type: object nullable: true - 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 @@ -127845,9 +129299,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -127905,12 +129356,14 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: string nullable: true @@ -127948,6 +129401,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: @@ -127960,16 +129430,6 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: string @@ -128029,6 +129489,7 @@ components: - watch - workflow_dispatch - workflow_run + - reminder external_url: type: string nullable: true @@ -128049,9 +129510,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -128114,6 +129572,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -128208,7 +129669,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -128279,11 +129739,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -128301,6 +129756,16 @@ components: type: string nullable: true format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -128323,17 +129788,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -128356,6 +129810,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 @@ -128395,9 +129860,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -128456,134 +129918,6 @@ components: - Bot - User - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - milestone: - "$ref": "#/components/schemas/webhooks_milestone" - 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-edited: - title: issues edited 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 - 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 - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 @@ -128592,12 +129926,165 @@ components: 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -128659,9 +130146,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -128707,6 +130191,15 @@ components: items: title: Label type: object + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -128728,14 +130221,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 @@ -128746,6 +130231,23 @@ components: description: A collection of related issues and pull requests. type: object nullable: true + 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 @@ -128760,6 +130262,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -128823,9 +130328,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id description: type: string nullable: true @@ -128863,23 +130365,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: @@ -128892,6 +130377,16 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: string @@ -128951,9 +130446,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - - reminder external_url: type: string nullable: true @@ -128974,6 +130466,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -129036,9 +130531,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -129204,11 +130696,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129226,16 +130713,6 @@ components: type: string nullable: true format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -129258,6 +130735,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -129280,17 +130768,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 @@ -129314,11 +130791,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 @@ -129330,6 +130807,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -129394,33 +130874,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: @@ -129429,18 +130884,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: @@ -129889,6 +131363,7 @@ components: - watch - workflow_dispatch - workflow_run + - security_and_analysis - pull_request_review_thread - reminder external_url: @@ -130141,11 +131616,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130366,17 +131836,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: @@ -130386,29 +131857,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: string @@ -130423,9 +131871,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -130483,20 +131928,21 @@ components: - 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 nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -130554,11 +132000,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. @@ -130604,15 +132052,6 @@ components: items: title: Label type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -130634,35 +132073,24 @@ 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 nullable: true - 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 @@ -130677,9 +132105,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -130737,11 +132162,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: string nullable: true @@ -130779,6 +132208,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: @@ -130791,16 +132237,6 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: string @@ -130860,8 +132296,8 @@ components: - watch - workflow_dispatch - workflow_run + - pull_request_review_thread - reminder - - security_and_analysis external_url: type: string nullable: true @@ -130882,9 +132318,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -130947,6 +132380,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -131041,6 +132477,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -131111,11 +132548,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131133,6 +132565,16 @@ components: type: string nullable: true format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -131155,17 +132597,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -131188,6 +132619,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 @@ -131227,9 +132669,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -131288,11 +132727,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: @@ -131304,14 +132771,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: @@ -131334,6 +132801,7 @@ components: - html_url - id - labels_url + - locked - milestone - node_id - number @@ -131420,6 +132888,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -131489,6 +132959,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. @@ -131569,6 +133041,8 @@ components: format: uri-template locked: type: boolean + enum: + - true milestone: title: Milestone description: A collection of related issues and pull requests. @@ -131665,7 +133139,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -131790,6 +133263,7 @@ components: - workflow_dispatch - workflow_run - reminder + - security_and_analysis external_url: type: string nullable: true @@ -131969,7 +133443,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -132040,7 +133513,926 @@ 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 + nullable: true + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 @@ -132941,11 +135333,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -134302,11 +136689,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135292,11 +137674,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136190,11 +138567,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137713,11 +140085,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -213787,7 +216154,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' @@ -216842,7 +219208,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 @@ -216855,11 +219221,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 @@ -228678,11 +231044,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 @@ -233272,7 +235638,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -233323,7 +235688,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -233567,7 +235931,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -233618,7 +235981,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -233850,7 +236212,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -233901,7 +236262,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -234158,7 +236518,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -234209,7 +236568,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 4965325bc..78fb8530e 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -15784,6 +15784,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" }, @@ -16266,6 +16276,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", @@ -82310,6 +82329,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.", @@ -101482,14 +101687,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.", @@ -111659,7 +111856,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", @@ -117358,7 +117555,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -117405,7 +117602,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -117452,7 +117649,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -117499,7 +117696,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -117546,7 +117743,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -139877,13 +140074,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -141263,13 +141453,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -150508,13 +150691,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -151331,13 +151507,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -152147,13 +152316,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -156164,13 +156326,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -160777,13 +160932,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -161416,13 +161564,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -165879,13 +166020,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -167450,13 +167584,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -169030,13 +169157,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -169664,244 +169784,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" @@ -169910,7 +169804,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", @@ -170480,10 +170374,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -170730,8 +170621,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -170962,12 +170852,3383 @@ "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", @@ -172271,13 +175532,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -173539,13 +176793,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -174778,13 +178025,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -176021,13 +179261,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -177301,13 +180534,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178534,13 +181760,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -179737,13 +182956,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -181542,13 +184754,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -182849,13 +186054,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -184048,13 +187246,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -186064,13 +189255,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -285237,7 +288421,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", @@ -288791,7 +291974,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -288812,61 +291995,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": [ @@ -302588,51 +305769,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": [ @@ -307919,7 +311098,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -307974,7 +311152,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308245,7 +311422,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308300,7 +311476,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308558,7 +311733,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308613,7 +311787,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308899,7 +312072,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -308954,7 +312126,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index bc76ee358..b140220fb 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -11424,6 +11424,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: @@ -11800,6 +11809,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 @@ -59514,284 +59531,18 @@ x-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 @@ -59833,7 +59584,7 @@ x-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 @@ -59841,23 +59592,23 @@ x-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 @@ -59899,7 +59650,7 @@ x-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 @@ -59907,23 +59658,23 @@ x-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 @@ -59965,7 +59716,7 @@ x-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 @@ -59973,23 +59724,24 @@ x-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 @@ -60031,7 +59783,7 @@ x-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 @@ -60039,12 +59791,145 @@ x-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. @@ -60052,8 +59937,8 @@ x-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: @@ -60097,7 +59982,7 @@ x-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 @@ -60110,7 +59995,7 @@ x-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. @@ -60118,8 +60003,8 @@ x-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: @@ -60163,7 +60048,7 @@ x-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 @@ -60176,7 +60061,7 @@ x-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. @@ -60184,9 +60069,8 @@ x-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: @@ -60230,7 +60114,7 @@ x-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 @@ -60243,7 +60127,7 @@ x-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. @@ -60251,8 +60135,8 @@ x-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: @@ -60296,7 +60180,7 @@ x-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 @@ -60309,7 +60193,7 @@ x-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. @@ -60317,9 +60201,8 @@ x-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: @@ -60363,7 +60246,7 @@ x-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 @@ -60376,7 +60259,7 @@ x-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. @@ -60384,9 +60267,8 @@ x-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: @@ -60430,7 +60312,7 @@ x-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 @@ -60443,7 +60325,7 @@ x-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. @@ -60451,8 +60333,9 @@ x-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: @@ -60496,7 +60379,7 @@ x-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 @@ -60509,7 +60392,7 @@ x-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. @@ -60517,9 +60400,8 @@ x-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: @@ -60563,7 +60445,7 @@ x-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 @@ -60576,7 +60458,7 @@ x-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. @@ -60584,8 +60466,275 @@ x-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: @@ -73318,13 +73467,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 @@ -81473,7 +81615,7 @@ components: cli: type: string description: The organization policy for allowing or disallowing Copilot - in the CLI. + CLI. enum: - enabled - disabled @@ -86050,7 +86192,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. @@ -86084,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. @@ -86118,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. @@ -86152,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. @@ -86186,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. @@ -103196,11 +103338,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -104241,11 +104378,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -111285,11 +111417,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -111914,11 +112041,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -112536,11 +112658,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -115598,11 +115715,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -118875,11 +118987,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -119358,11 +119465,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122576,11 +122678,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -123744,11 +123841,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -124919,11 +125011,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125375,182 +125462,23 @@ components: - 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 + webhook-issue-comment-pinned: + title: issue_comment pinned 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) @@ -125998,9 +125926,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - reminder - - pull_request_review_thread external_url: type: string nullable: true @@ -126180,7 +126105,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -126345,10 +126269,6 @@ 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 @@ -126472,8 +126392,75 @@ components: type: string nullable: true assignee: + title: User type: object nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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: @@ -126502,8 +126489,37 @@ components: labels: type: array items: + title: Label type: object - nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + 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: @@ -126544,10 +126560,11 @@ components: repository_url: type: string state: + description: State of the issue; either 'open' or 'closed' type: string enum: - - closed - open + - closed timeline_url: type: string title: @@ -126599,8 +126616,10 @@ components: user_view_type: type: string required: + - labels - state - - closed_at + - locked + - assignee organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -126610,107 +126629,42 @@ components: 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" 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 - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: title: User type: object nullable: true @@ -126771,6 +126725,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -126779,101 +126734,9 @@ components: 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 - nullable: true - closed_at: - type: string - nullable: true - 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 - nullable: true - 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 - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: + assignees: + type: array + items: title: User type: object nullable: true @@ -126934,6 +126797,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -126942,595 +126806,990 @@ components: required: - login - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - 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 - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - 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 - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User + 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 + nullable: true + closed_at: + type: string + nullable: true + 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 - nullable: true properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - 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: + description: URL for the label 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: + - 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: type: string enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - 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 - nullable: true - 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 - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 + - 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: @@ -127540,16 +127799,1249 @@ components: required: - action - issue + - comment - repository - sender - webhook-issues-demilestoned: - title: issues demilestoned event + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event type: object properties: action: type: string enum: - - demilestoned + - 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + type: object + nullable: true + assignees: + type: array + items: + type: object + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + labels_url: + type: string + locked: + type: boolean + milestone: + type: object + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: @@ -127559,28 +129051,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 - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user properties: active_lock_reason: type: string @@ -127595,9 +129065,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -127655,19 +129122,20 @@ components: - 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 nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -127725,10 +129193,14 @@ 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. @@ -127774,15 +129246,6 @@ components: items: title: Label type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -127804,6 +129267,14 @@ 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 @@ -127814,23 +129285,6 @@ components: description: A collection of related issues and pull requests. type: object nullable: true - 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 @@ -127845,9 +129299,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -127905,12 +129356,14 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: string nullable: true @@ -127948,6 +129401,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: @@ -127960,16 +129430,6 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: string @@ -128029,6 +129489,7 @@ components: - watch - workflow_dispatch - workflow_run + - reminder external_url: type: string nullable: true @@ -128049,9 +129510,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -128114,6 +129572,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -128208,7 +129669,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -128279,11 +129739,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -128301,6 +129756,16 @@ components: type: string nullable: true format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -128323,17 +129788,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -128356,6 +129810,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 @@ -128395,9 +129860,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -128456,134 +129918,6 @@ components: - Bot - User - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - milestone: - "$ref": "#/components/schemas/webhooks_milestone" - 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-edited: - title: issues edited 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 - 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 - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 @@ -128592,12 +129926,165 @@ components: 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -128659,9 +130146,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -128707,6 +130191,15 @@ components: items: title: Label type: object + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -128728,14 +130221,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 @@ -128746,6 +130231,23 @@ components: description: A collection of related issues and pull requests. type: object nullable: true + 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 @@ -128760,6 +130262,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -128823,9 +130328,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id description: type: string nullable: true @@ -128863,23 +130365,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: @@ -128892,6 +130377,16 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: string @@ -128951,9 +130446,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - - reminder external_url: type: string nullable: true @@ -128974,6 +130466,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -129036,9 +130531,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -129204,11 +130696,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129226,16 +130713,6 @@ components: type: string nullable: true format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -129258,6 +130735,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -129280,17 +130768,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 @@ -129314,11 +130791,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 @@ -129330,6 +130807,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -129394,33 +130874,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: @@ -129429,18 +130884,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: @@ -129889,6 +131363,7 @@ components: - watch - workflow_dispatch - workflow_run + - security_and_analysis - pull_request_review_thread - reminder external_url: @@ -130141,11 +131616,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130366,17 +131836,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: @@ -130386,29 +131857,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: string @@ -130423,9 +131871,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -130483,20 +131928,21 @@ components: - 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 nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -130554,11 +132000,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. @@ -130604,15 +132052,6 @@ components: items: title: Label type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -130634,35 +132073,24 @@ 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 nullable: true - 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 @@ -130677,9 +132105,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -130737,11 +132162,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: string nullable: true @@ -130779,6 +132208,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: @@ -130791,16 +132237,6 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: string @@ -130860,8 +132296,8 @@ components: - watch - workflow_dispatch - workflow_run + - pull_request_review_thread - reminder - - security_and_analysis external_url: type: string nullable: true @@ -130882,9 +132318,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -130947,6 +132380,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -131041,6 +132477,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -131111,11 +132548,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131133,6 +132565,16 @@ components: type: string nullable: true format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -131155,17 +132597,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -131188,6 +132619,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 @@ -131227,9 +132669,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -131288,11 +132727,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: @@ -131304,14 +132771,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: @@ -131334,6 +132801,7 @@ components: - html_url - id - labels_url + - locked - milestone - node_id - number @@ -131420,6 +132888,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -131489,6 +132959,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. @@ -131569,6 +133041,8 @@ components: format: uri-template locked: type: boolean + enum: + - true milestone: title: Milestone description: A collection of related issues and pull requests. @@ -131665,7 +133139,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -131790,6 +133263,7 @@ components: - workflow_dispatch - workflow_run - reminder + - security_and_analysis external_url: type: string nullable: true @@ -131969,7 +133443,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -132040,7 +133513,926 @@ 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 + nullable: true + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 @@ -132941,11 +135333,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -134302,11 +136689,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135292,11 +137674,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136190,11 +138567,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137713,11 +140085,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -213787,7 +216154,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' @@ -216842,7 +219208,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 @@ -216855,11 +219221,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 @@ -228678,11 +231044,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 @@ -233272,7 +235638,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -233323,7 +235688,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -233567,7 +235931,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -233618,7 +235981,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -233850,7 +236212,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -233901,7 +236262,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -234158,7 +236518,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -234209,7 +236568,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 5e8e0c0c3..67e819a51 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -5057,14 +5057,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.", @@ -6050,14 +6042,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.", @@ -6897,14 +6881,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.", @@ -7375,14 +7351,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.", @@ -9408,14 +9376,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.", @@ -10452,14 +10412,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.", @@ -11413,14 +11365,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.", @@ -12085,14 +12029,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.", @@ -93223,6 +93159,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", "description": "Security Configuration feature options for code scanning", @@ -94967,6 +94913,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", @@ -101328,7 +101283,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", @@ -119917,7 +119872,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", @@ -121444,14 +121398,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.", @@ -122452,14 +122398,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.", @@ -180676,7 +180614,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -180723,7 +180661,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -180770,7 +180708,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -180817,7 +180755,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -180864,7 +180802,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -181956,7 +181894,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -182003,7 +181941,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -182050,7 +181988,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -182097,7 +182035,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -182144,7 +182082,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183321,7 +183259,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183368,7 +183306,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183415,7 +183353,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183462,7 +183400,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183509,7 +183447,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185327,7 +185265,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185374,7 +185312,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185421,7 +185359,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185468,7 +185406,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185515,7 +185453,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186632,7 +186570,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186679,7 +186617,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186726,7 +186664,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186773,7 +186711,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186820,7 +186758,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -187993,7 +187931,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188040,7 +187978,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188087,7 +188025,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188134,7 +188072,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188181,7 +188119,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188809,7 +188747,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -188990,61 +188928,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" } - ] - } + } + ] } - ] + } } } } @@ -344398,14 +344334,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.", @@ -478234,7 +478162,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -478307,7 +478235,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -478380,7 +478308,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -478453,7 +478381,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -478526,7 +478454,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -479970,7 +479898,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -480017,7 +479945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -480064,7 +479992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -480111,7 +480039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -480158,7 +480086,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481117,7 +481045,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481164,7 +481092,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481211,7 +481139,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481258,7 +481186,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481305,7 +481233,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482472,7 +482400,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482519,7 +482447,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482566,7 +482494,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482613,7 +482541,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482660,7 +482588,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484497,7 +484425,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484544,7 +484472,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484591,7 +484519,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484638,7 +484566,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484685,7 +484613,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485659,7 +485587,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485706,7 +485634,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485753,7 +485681,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485800,7 +485728,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485847,7 +485775,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487010,7 +486938,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487057,7 +486985,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487104,7 +487032,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487151,7 +487079,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487198,7 +487126,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487834,7 +487762,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -488024,51 +487952,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" } - ] - } + } + ] } - ] + } } } } @@ -555203,14 +555129,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.", @@ -621716,14 +621634,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.", @@ -677733,7 +677643,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -677788,7 +677697,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -681780,7 +681688,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -681835,7 +681742,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -685825,7 +685731,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -685880,7 +685785,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -689887,7 +689791,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -689942,7 +689845,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -690649,13 +690551,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -693050,13 +692945,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -695444,13 +695332,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -740345,13 +740226,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -757113,13 +756987,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -757752,13 +757619,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -805528,14 +805388,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.", @@ -808128,14 +807980,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.", @@ -810635,14 +810479,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.", @@ -813142,14 +812978,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.", @@ -815781,14 +815609,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.", @@ -818427,14 +818247,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.", @@ -822696,14 +822508,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.", @@ -826060,13 +825864,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -829825,13 +829622,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -833614,13 +833404,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -835768,13 +835551,13 @@ } } }, - "issue-dependencies-blocked-by-added": { + "issue-comment-pinned": { "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.", - "description": "An issue was marked as blocked by another issue.", - "operationId": "issue-dependencies/blocked-by-added", + "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-dependencies" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -835839,1726 +835622,9262 @@ "content": { "application/json": { "schema": { - "title": "blocked by issue added event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "blocked_by_added" + "pinned" ] }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" - }, "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", - "type": "string", - "nullable": true - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true + "description": "Contents of the issue comment", + "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "body_html": { - "type": "string" + "format": "uri" }, - "body_text": { - "type": "string" + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" }, - "timeline_url": { + "issue_url": { "type": "string", "format": "uri" }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "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", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "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" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "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" - ] + "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", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "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.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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" + ] + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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-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": { + "title": "issue_comment unpinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unpinned" + ] + }, + "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", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "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.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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" + ] + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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-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.", + "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": { + "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": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "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" + ] }, "performed_via_github_app": { "title": "GitHub app", @@ -863985,13 +871304,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -866982,13 +874294,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -870171,13 +877476,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -873189,13 +880487,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -876358,13 +883649,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -879389,13 +886673,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -882457,13 +889734,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -885440,13 +892710,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -888490,13 +895753,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -890550,13 +897806,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -893535,13 +900784,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -896556,13 +903798,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -899422,13 +906657,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -901498,13 +908726,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -904490,13 +911711,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -907640,13 +914854,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -910632,13 +917839,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -913698,13 +920898,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -916649,13 +923842,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -919640,13 +926826,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1207880,7 +1215059,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1207927,7 +1215106,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1207974,7 +1215153,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1208021,7 +1215200,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1208068,7 +1215247,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210805,7 +1217984,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210852,7 +1218031,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210899,7 +1218078,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210946,7 +1218125,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210993,7 +1218172,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213730,7 +1220909,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213777,7 +1220956,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213824,7 +1221003,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213871,7 +1221050,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213918,7 +1221097,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214804,7 +1221983,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214851,7 +1222030,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214898,7 +1222077,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214945,7 +1222124,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214992,7 +1222171,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215706,7 +1222885,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215753,7 +1222932,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215800,7 +1222979,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215847,7 +1223026,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215894,7 +1223073,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216611,7 +1223790,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216658,7 +1223837,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216705,7 +1223884,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216752,7 +1223931,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216799,7 +1223978,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index e9088727d..0658e121f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -2521,13 +2521,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 @@ -27047,6 +27040,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: *51 code_scanning_default_setup: type: string @@ -27404,6 +27406,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 @@ -29239,7 +29249,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -31954,7 +31964,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' @@ -42762,7 +42771,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 @@ -42798,7 +42808,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 @@ -42834,7 +42845,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 @@ -42870,7 +42882,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 @@ -42906,7 +42919,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 @@ -43885,7 +43899,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 @@ -43945,11 +43959,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 @@ -89481,11 +89495,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 @@ -108030,7 +108044,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -108081,7 +108094,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -108427,7 +108439,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -108478,7 +108489,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -108824,7 +108834,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -108875,7 +108884,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -109236,7 +109244,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -109287,7 +109294,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -109851,11 +109857,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -110550,11 +110551,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -111242,11 +111238,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -115825,11 +115816,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -119634,492 +119620,482 @@ x-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 - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - 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 - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 @@ -125502,11 +125478,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125963,7 +125934,2625 @@ x-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: &740 + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + enterprise: *716 + installation: *717 + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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: *650 + issue_dependencies_summary: *651 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *226 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: *718 + repository: *719 + 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: &769 + 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: *740 + enterprise: *716 + installation: *717 + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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: *650 + issue_dependencies_summary: *651 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *226 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: *718 + repository: *719 + 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. @@ -125971,8 +128560,8 @@ x-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: @@ -126016,178 +128605,14 @@ x-webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &740 - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: *740 enterprise: *716 installation: *717 issue: @@ -127352,7 +129777,7 @@ x-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. @@ -127360,8 +129785,8 @@ x-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: @@ -127405,25 +129830,13 @@ x-webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &769 - 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: *740 enterprise: *716 installation: *717 @@ -127877,8 +130290,6 @@ x-webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: string nullable: true @@ -128058,7 +130469,6 @@ x-webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -128564,6 +130974,8 @@ x-webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -128574,7 +130986,6 @@ x-webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -129716,11 +132127,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130713,11 +133119,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131835,11 +134236,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -132853,11 +135249,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -133970,11 +136361,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -134962,11 +137348,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135988,11 +138369,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136973,11 +139349,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137931,11 +140302,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139287,11 +141653,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -140273,11 +142634,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -141294,11 +143650,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142250,11 +144601,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -144067,11 +146413,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 5e8e0c0c3..67e819a51 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -5057,14 +5057,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.", @@ -6050,14 +6042,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.", @@ -6897,14 +6881,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.", @@ -7375,14 +7351,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.", @@ -9408,14 +9376,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.", @@ -10452,14 +10412,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.", @@ -11413,14 +11365,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.", @@ -12085,14 +12029,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.", @@ -93223,6 +93159,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", "description": "Security Configuration feature options for code scanning", @@ -94967,6 +94913,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", @@ -101328,7 +101283,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", @@ -119917,7 +119872,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", @@ -121444,14 +121398,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.", @@ -122452,14 +122398,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.", @@ -180676,7 +180614,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -180723,7 +180661,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -180770,7 +180708,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -180817,7 +180755,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -180864,7 +180802,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -181956,7 +181894,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -182003,7 +181941,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -182050,7 +181988,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -182097,7 +182035,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -182144,7 +182082,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183321,7 +183259,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183368,7 +183306,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183415,7 +183353,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183462,7 +183400,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -183509,7 +183447,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185327,7 +185265,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185374,7 +185312,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185421,7 +185359,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185468,7 +185406,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -185515,7 +185453,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186632,7 +186570,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186679,7 +186617,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186726,7 +186664,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186773,7 +186711,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -186820,7 +186758,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -187993,7 +187931,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188040,7 +187978,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188087,7 +188025,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188134,7 +188072,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188181,7 +188119,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -188809,7 +188747,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -188990,61 +188928,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" } - ] - } + } + ] } - ] + } } } } @@ -344398,14 +344334,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.", @@ -478234,7 +478162,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -478307,7 +478235,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -478380,7 +478308,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -478453,7 +478381,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -478526,7 +478454,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -479970,7 +479898,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -480017,7 +479945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -480064,7 +479992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -480111,7 +480039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -480158,7 +480086,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481117,7 +481045,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481164,7 +481092,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481211,7 +481139,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481258,7 +481186,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -481305,7 +481233,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482472,7 +482400,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482519,7 +482447,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482566,7 +482494,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482613,7 +482541,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -482660,7 +482588,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484497,7 +484425,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484544,7 +484472,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484591,7 +484519,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484638,7 +484566,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -484685,7 +484613,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485659,7 +485587,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485706,7 +485634,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485753,7 +485681,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485800,7 +485728,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -485847,7 +485775,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487010,7 +486938,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487057,7 +486985,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487104,7 +487032,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487151,7 +487079,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487198,7 +487126,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -487834,7 +487762,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -488024,51 +487952,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" } - ] - } + } + ] } - ] + } } } } @@ -555203,14 +555129,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.", @@ -621716,14 +621634,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.", @@ -677733,7 +677643,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -677788,7 +677697,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -681780,7 +681688,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -681835,7 +681742,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -685825,7 +685731,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -685880,7 +685785,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -689887,7 +689791,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -689942,7 +689845,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -690649,13 +690551,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -693050,13 +692945,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -695444,13 +695332,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -740345,13 +740226,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -757113,13 +756987,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -757752,13 +757619,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -805528,14 +805388,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.", @@ -808128,14 +807980,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.", @@ -810635,14 +810479,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.", @@ -813142,14 +812978,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.", @@ -815781,14 +815609,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.", @@ -818427,14 +818247,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.", @@ -822696,14 +822508,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.", @@ -826060,13 +825864,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -829825,13 +829622,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -833614,13 +833404,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -835768,13 +835551,13 @@ } } }, - "issue-dependencies-blocked-by-added": { + "issue-comment-pinned": { "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.", - "description": "An issue was marked as blocked by another issue.", - "operationId": "issue-dependencies/blocked-by-added", + "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-dependencies" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -835839,1726 +835622,9262 @@ "content": { "application/json": { "schema": { - "title": "blocked by issue added event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "blocked_by_added" + "pinned" ] }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" - }, "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", - "type": "string", - "nullable": true - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true + "description": "Contents of the issue comment", + "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "body_html": { - "type": "string" + "format": "uri" }, - "body_text": { - "type": "string" + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" }, - "timeline_url": { + "issue_url": { "type": "string", "format": "uri" }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "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", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "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" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "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" - ] + "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", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "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.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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" + ] + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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-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": { + "title": "issue_comment unpinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unpinned" + ] + }, + "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", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "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.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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" + ] + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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-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.", + "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": { + "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": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "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" + ] }, "performed_via_github_app": { "title": "GitHub app", @@ -863985,13 +871304,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -866982,13 +874294,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -870171,13 +877476,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -873189,13 +880487,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -876358,13 +883649,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -879389,13 +886673,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -882457,13 +889734,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -885440,13 +892710,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -888490,13 +895753,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -890550,13 +897806,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -893535,13 +900784,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -896556,13 +903798,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -899422,13 +906657,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -901498,13 +908726,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -904490,13 +911711,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -907640,13 +914854,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -910632,13 +917839,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -913698,13 +920898,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -916649,13 +923842,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -919640,13 +926826,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1207880,7 +1215059,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1207927,7 +1215106,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1207974,7 +1215153,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1208021,7 +1215200,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1208068,7 +1215247,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210805,7 +1217984,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210852,7 +1218031,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210899,7 +1218078,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210946,7 +1218125,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1210993,7 +1218172,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213730,7 +1220909,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213777,7 +1220956,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213824,7 +1221003,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213871,7 +1221050,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1213918,7 +1221097,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214804,7 +1221983,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214851,7 +1222030,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214898,7 +1222077,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214945,7 +1222124,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1214992,7 +1222171,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215706,7 +1222885,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215753,7 +1222932,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215800,7 +1222979,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215847,7 +1223026,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1215894,7 +1223073,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216611,7 +1223790,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216658,7 +1223837,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216705,7 +1223884,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216752,7 +1223931,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1216799,7 +1223978,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/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index e9088727d..0658e121f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -2521,13 +2521,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 @@ -27047,6 +27040,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: *51 code_scanning_default_setup: type: string @@ -27404,6 +27406,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 @@ -29239,7 +29249,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -31954,7 +31964,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' @@ -42762,7 +42771,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 @@ -42798,7 +42808,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 @@ -42834,7 +42845,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 @@ -42870,7 +42882,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 @@ -42906,7 +42919,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 @@ -43885,7 +43899,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 @@ -43945,11 +43959,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 @@ -89481,11 +89495,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 @@ -108030,7 +108044,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -108081,7 +108094,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -108427,7 +108439,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -108478,7 +108489,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -108824,7 +108834,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -108875,7 +108884,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -109236,7 +109244,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -109287,7 +109294,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -109851,11 +109857,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -110550,11 +110551,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -111242,11 +111238,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -115825,11 +115816,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -119634,492 +119620,482 @@ x-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 - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - 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 - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 @@ -125502,11 +125478,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125963,7 +125934,2625 @@ x-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: &740 + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + enterprise: *716 + installation: *717 + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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: *650 + issue_dependencies_summary: *651 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *226 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: *718 + repository: *719 + 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: &769 + 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: *740 + enterprise: *716 + installation: *717 + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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: *650 + issue_dependencies_summary: *651 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *226 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: *718 + repository: *719 + 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. @@ -125971,8 +128560,8 @@ x-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: @@ -126016,178 +128605,14 @@ x-webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &740 - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: *740 enterprise: *716 installation: *717 issue: @@ -127352,7 +129777,7 @@ x-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. @@ -127360,8 +129785,8 @@ x-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: @@ -127405,25 +129830,13 @@ x-webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &769 - 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: *740 enterprise: *716 installation: *717 @@ -127877,8 +130290,6 @@ x-webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: string nullable: true @@ -128058,7 +130469,6 @@ x-webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -128564,6 +130974,8 @@ x-webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -128574,7 +130986,6 @@ x-webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -129716,11 +132127,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130713,11 +133119,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131835,11 +134236,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -132853,11 +135249,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -133970,11 +136361,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -134962,11 +137348,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135988,11 +138369,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -136973,11 +139349,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -137931,11 +140302,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139287,11 +141653,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -140273,11 +142634,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -141294,11 +143650,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142250,11 +144601,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -144067,11 +146413,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index ea6e21b3b..635beb044 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -5073,14 +5073,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.", @@ -6082,14 +6074,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.", @@ -6945,14 +6929,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.", @@ -7439,14 +7415,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.", @@ -9488,14 +9456,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.", @@ -10548,14 +10508,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.", @@ -11525,14 +11477,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.", @@ -12213,14 +12157,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.", @@ -28388,14 +28324,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.", @@ -29192,14 +29120,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.", @@ -30152,14 +30072,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.", @@ -31503,14 +31415,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.", @@ -53122,7 +53026,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53169,7 +53073,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53216,7 +53120,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53263,7 +53167,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53310,7 +53214,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53626,7 +53530,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -53647,7 +53551,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -54473,7 +54377,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54520,7 +54424,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54567,7 +54471,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54614,7 +54518,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54661,7 +54565,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54982,7 +54886,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -55000,7 +54904,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -55930,7 +55834,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -55977,7 +55881,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -56024,7 +55928,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -56071,7 +55975,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -56118,7 +56022,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -56439,7 +56343,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -56457,7 +56361,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -57761,7 +57665,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -57808,7 +57712,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -57855,7 +57759,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -57902,7 +57806,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -57949,7 +57853,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58261,7 +58165,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -58282,7 +58186,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -59108,7 +59012,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59155,7 +59059,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59202,7 +59106,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59249,7 +59153,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59296,7 +59200,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59617,7 +59521,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -59635,7 +59539,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -59910,7 +59814,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -60091,41 +59995,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" + } + ] } - ] + } } } } @@ -138175,6 +138077,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", "description": "Security Configuration feature options for code scanning", @@ -139919,6 +139831,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", @@ -146304,7 +146225,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", @@ -170300,7 +170221,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", @@ -171827,14 +171747,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.", @@ -172851,14 +172763,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.", @@ -232367,7 +232271,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -232414,7 +232318,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -232461,7 +232365,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -232508,7 +232412,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -232555,7 +232459,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233648,7 +233552,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233695,7 +233599,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233742,7 +233646,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233789,7 +233693,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233836,7 +233740,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235014,7 +234918,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235061,7 +234965,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235108,7 +235012,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235155,7 +235059,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235202,7 +235106,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237021,7 +236925,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237068,7 +236972,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237115,7 +237019,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237162,7 +237066,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237209,7 +237113,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238327,7 +238231,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238374,7 +238278,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238421,7 +238325,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238468,7 +238372,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238515,7 +238419,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239689,7 +239593,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239736,7 +239640,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239783,7 +239687,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239830,7 +239734,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239877,7 +239781,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -240505,7 +240409,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -240686,61 +240590,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" } - ] - } + } + ] } - ] + } } } } @@ -403351,14 +403253,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.", @@ -537370,7 +537264,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -537443,7 +537337,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -537516,7 +537410,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -537589,7 +537483,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -537662,7 +537556,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539107,7 +539001,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539154,7 +539048,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539201,7 +539095,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539248,7 +539142,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539295,7 +539189,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540255,7 +540149,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540302,7 +540196,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540349,7 +540243,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540396,7 +540290,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540443,7 +540337,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541611,7 +541505,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541658,7 +541552,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541705,7 +541599,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541752,7 +541646,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541799,7 +541693,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543637,7 +543531,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543684,7 +543578,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543731,7 +543625,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543778,7 +543672,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543825,7 +543719,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544800,7 +544694,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544847,7 +544741,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544894,7 +544788,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544941,7 +544835,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544988,7 +544882,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546152,7 +546046,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546199,7 +546093,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546246,7 +546140,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546293,7 +546187,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546340,7 +546234,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546976,7 +546870,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -547166,51 +547060,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" } - ] - } + } + ] } - ] + } } } } @@ -625005,14 +624897,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.", @@ -691618,14 +691502,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.", @@ -756766,7 +756642,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -756821,7 +756696,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -760825,7 +760699,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -760880,7 +760753,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -764882,7 +764754,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -764937,7 +764808,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -768956,7 +768826,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -769011,7 +768880,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -769718,13 +769586,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -772119,13 +771980,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -774513,13 +774367,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -819414,13 +819261,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -836182,646 +836022,632 @@ "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", - "nullable": true, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "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", - "nullable": true, - "properties": { - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "nullable": true - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", @@ -914891,14 +914717,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.", @@ -917507,14 +917325,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.", @@ -920030,14 +919840,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.", @@ -922553,14 +922355,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.", @@ -925208,14 +925002,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.", @@ -927870,14 +927656,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.", @@ -932155,14 +931933,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.", @@ -935535,13 +935305,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -939300,13 +939063,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -943089,13 +942845,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -945243,13 +944992,13 @@ } } }, - "issue-dependencies-blocked-by-added": { + "issue-comment-pinned": { "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.", - "description": "An issue was marked as blocked by another issue.", - "operationId": "issue-dependencies/blocked-by-added", + "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 was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -945314,1726 +945063,9262 @@ "content": { "application/json": { "schema": { - "title": "blocked by issue added event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "blocked_by_added" + "pinned" ] }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "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": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" - }, "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", - "type": "string", - "nullable": true - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true + "description": "Contents of the issue comment", + "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "body_html": { - "type": "string" + "format": "uri" }, - "body_text": { - "type": "string" + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" }, - "timeline_url": { + "issue_url": { "type": "string", "format": "uri" }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "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", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "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" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "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" - ] + "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", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "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.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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" + ] + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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-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 was unpinned.", + "operationId": "issue-comment/unpinned", + "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 unpinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unpinned" + ] + }, + "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", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "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.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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" + ] + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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-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.", + "description": "An issue was marked as blocked by another issue.", + "operationId": "issue-dependencies/blocked-by-added", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//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": { + "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": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "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" + ] }, "performed_via_github_app": { "title": "GitHub app", @@ -973460,13 +980745,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -976457,13 +983735,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -979646,13 +986917,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -982664,13 +989928,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -985833,13 +993090,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -988864,13 +996114,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -991932,13 +999175,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -994915,13 +1002151,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -997965,13 +1005194,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1000025,13 +1007247,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1003010,13 +1010225,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1006031,13 +1013239,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1008897,13 +1016098,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1010973,13 +1018167,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1013965,13 +1021152,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1017115,13 +1024295,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1020107,13 +1027280,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1023173,13 +1030339,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1026124,13 +1033283,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1029115,13 +1036267,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1318948,7 +1326093,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1318995,7 +1326140,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1319042,7 +1326187,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1319089,7 +1326234,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1319136,7 +1326281,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1321874,7 +1329019,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1321921,7 +1329066,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1321968,7 +1329113,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1322015,7 +1329160,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1322062,7 +1329207,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324800,7 +1331945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324847,7 +1331992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324894,7 +1332039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324941,7 +1332086,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324988,7 +1332133,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1325874,7 +1333019,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1325921,7 +1333066,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1325968,7 +1333113,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326015,7 +1333160,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326062,7 +1333207,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326776,7 +1333921,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326823,7 +1333968,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326870,7 +1334015,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326917,7 +1334062,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326964,7 +1334109,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327681,7 +1334826,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327728,7 +1334873,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327775,7 +1334920,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327822,7 +1334967,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327869,7 +1335014,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/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 239367d8b..6af52fa91 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -2530,13 +2530,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 @@ -20274,7 +20267,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 pattern @@ -20310,7 +20304,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 pattern @@ -20346,7 +20341,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 pattern @@ -20382,7 +20378,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 pattern @@ -20418,7 +20415,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 pattern @@ -20672,7 +20670,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -20685,7 +20683,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '201': description: Response @@ -20925,7 +20923,7 @@ paths: value: id: 21 name: super cool ruleset - target: repository + target: branch source_type: Enterprise source: my-enterprise enforcement: active @@ -20937,7 +20935,7 @@ paths: include: - "~ALL" rules: - - type: repository_delete + - type: deletion node_id: RRS_lACkVXNlcgQB _links: self: @@ -21040,7 +21038,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -21053,7 +21051,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '200': description: Response @@ -21153,7 +21151,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 @@ -21213,11 +21211,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 @@ -39616,6 +39614,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: *118 code_scanning_default_setup: type: string @@ -39973,6 +39980,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 @@ -41808,7 +41823,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -45790,7 +45805,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' @@ -56854,11 +56868,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 @@ -102884,11 +102898,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 @@ -123926,7 +123940,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -123977,7 +123990,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -124323,7 +124335,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -124374,7 +124385,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -124720,7 +124730,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -124771,7 +124780,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -125132,7 +125140,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -125183,7 +125190,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -125747,11 +125753,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -126446,11 +126447,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -127138,11 +127134,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131721,11 +131712,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135530,492 +135516,482 @@ x-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 - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - 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 - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 @@ -142370,11 +142346,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142831,7 +142802,2625 @@ x-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/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. + + 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/enterprise-cloud@latest//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/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: &884 + 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: *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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + enterprise: *853 + installation: *854 + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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: *791 + issue_dependencies_summary: *792 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *371 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: *855 + repository: *856 + 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/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. + + 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/enterprise-cloud@latest//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/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: &913 + 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: *884 + enterprise: *853 + installation: *854 + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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: *791 + issue_dependencies_summary: *792 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *371 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: *855 + repository: *856 + 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/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. @@ -142839,8 +145428,8 @@ x-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/enterprise-cloud@latest//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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -142884,178 +145473,14 @@ x-webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &884 - 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: *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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: *884 enterprise: *853 installation: *854 issue: @@ -144220,7 +146645,7 @@ x-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/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. @@ -144228,8 +146653,8 @@ x-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/enterprise-cloud@latest//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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -144273,25 +146698,13 @@ x-webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &913 - 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: *884 enterprise: *853 installation: *854 @@ -144745,8 +147158,6 @@ x-webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: string nullable: true @@ -144926,7 +147337,6 @@ x-webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -145432,6 +147842,8 @@ x-webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -145442,7 +147854,6 @@ x-webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -146584,11 +148995,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -147581,11 +149987,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -148703,11 +151104,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -149721,11 +152117,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -150838,11 +153229,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -151830,11 +154216,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -152856,11 +155237,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -153841,11 +156217,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -154799,11 +157170,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -156155,11 +158521,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -157141,11 +159502,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -158162,11 +160518,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -159118,11 +161469,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -160935,11 +163281,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index ea6e21b3b..635beb044 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -5073,14 +5073,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.", @@ -6082,14 +6074,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.", @@ -6945,14 +6929,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.", @@ -7439,14 +7415,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.", @@ -9488,14 +9456,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.", @@ -10548,14 +10508,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.", @@ -11525,14 +11477,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.", @@ -12213,14 +12157,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.", @@ -28388,14 +28324,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.", @@ -29192,14 +29120,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.", @@ -30152,14 +30072,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.", @@ -31503,14 +31415,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.", @@ -53122,7 +53026,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53169,7 +53073,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53216,7 +53120,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53263,7 +53167,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53310,7 +53214,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -53626,7 +53530,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -53647,7 +53551,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -54473,7 +54377,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54520,7 +54424,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54567,7 +54471,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54614,7 +54518,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54661,7 +54565,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -54982,7 +54886,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -55000,7 +54904,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -55930,7 +55834,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -55977,7 +55881,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -56024,7 +55928,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -56071,7 +55975,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -56118,7 +56022,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -56439,7 +56343,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -56457,7 +56361,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -57761,7 +57665,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -57808,7 +57712,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -57855,7 +57759,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -57902,7 +57806,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -57949,7 +57853,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -58261,7 +58165,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -58282,7 +58186,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -59108,7 +59012,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59155,7 +59059,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59202,7 +59106,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59249,7 +59153,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59296,7 +59200,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -59617,7 +59521,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -59635,7 +59539,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -59910,7 +59814,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -60091,41 +59995,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" + } + ] } - ] + } } } } @@ -138175,6 +138077,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", "description": "Security Configuration feature options for code scanning", @@ -139919,6 +139831,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", @@ -146304,7 +146225,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", @@ -170300,7 +170221,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", @@ -171827,14 +171747,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.", @@ -172851,14 +172763,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.", @@ -232367,7 +232271,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -232414,7 +232318,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -232461,7 +232365,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -232508,7 +232412,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -232555,7 +232459,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233648,7 +233552,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233695,7 +233599,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233742,7 +233646,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233789,7 +233693,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -233836,7 +233740,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235014,7 +234918,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235061,7 +234965,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235108,7 +235012,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235155,7 +235059,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -235202,7 +235106,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237021,7 +236925,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237068,7 +236972,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237115,7 +237019,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237162,7 +237066,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -237209,7 +237113,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238327,7 +238231,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238374,7 +238278,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238421,7 +238325,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238468,7 +238372,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -238515,7 +238419,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239689,7 +239593,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239736,7 +239640,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239783,7 +239687,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239830,7 +239734,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -239877,7 +239781,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -240505,7 +240409,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -240686,61 +240590,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" } - ] - } + } + ] } - ] + } } } } @@ -403351,14 +403253,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.", @@ -537370,7 +537264,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -537443,7 +537337,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -537516,7 +537410,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -537589,7 +537483,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -537662,7 +537556,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539107,7 +539001,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539154,7 +539048,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539201,7 +539095,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539248,7 +539142,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -539295,7 +539189,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540255,7 +540149,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540302,7 +540196,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540349,7 +540243,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540396,7 +540290,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -540443,7 +540337,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541611,7 +541505,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541658,7 +541552,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541705,7 +541599,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541752,7 +541646,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -541799,7 +541693,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543637,7 +543531,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543684,7 +543578,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543731,7 +543625,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543778,7 +543672,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -543825,7 +543719,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544800,7 +544694,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544847,7 +544741,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544894,7 +544788,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544941,7 +544835,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -544988,7 +544882,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546152,7 +546046,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546199,7 +546093,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546246,7 +546140,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546293,7 +546187,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546340,7 +546234,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -546976,7 +546870,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -547166,51 +547060,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" } - ] - } + } + ] } - ] + } } } } @@ -625005,14 +624897,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.", @@ -691618,14 +691502,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.", @@ -756766,7 +756642,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -756821,7 +756696,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -760825,7 +760699,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -760880,7 +760753,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -764882,7 +764754,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -764937,7 +764808,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -768956,7 +768826,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -769011,7 +768880,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -769718,13 +769586,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -772119,13 +771980,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -774513,13 +774367,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -819414,13 +819261,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -836182,646 +836022,632 @@ "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", - "nullable": true, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "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", - "nullable": true, - "properties": { - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "nullable": true - }, - "name": { - "description": "The name of the GitHub app", - "type": "string" - }, - "node_id": { - "type": "string" - }, - "owner": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", @@ -914891,14 +914717,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.", @@ -917507,14 +917325,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.", @@ -920030,14 +919840,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.", @@ -922553,14 +922355,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.", @@ -925208,14 +925002,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.", @@ -927870,14 +927656,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.", @@ -932155,14 +931933,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.", @@ -935535,13 +935305,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -939300,13 +939063,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -943089,13 +942845,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -945243,13 +944992,13 @@ } } }, - "issue-dependencies-blocked-by-added": { + "issue-comment-pinned": { "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.", - "description": "An issue was marked as blocked by another issue.", - "operationId": "issue-dependencies/blocked-by-added", + "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 was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -945314,1726 +945063,9262 @@ "content": { "application/json": { "schema": { - "title": "blocked by issue added event", + "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "blocked_by_added" + "pinned" ] }, - "blocked_issue_id": { - "description": "The ID of the blocked issue.", - "type": "number" - }, - "blocked_issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "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": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" - }, "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", - "type": "string", - "nullable": true - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true + "description": "Contents of the issue comment", + "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "body_html": { - "type": "string" + "format": "uri" }, - "body_text": { - "type": "string" + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" }, - "timeline_url": { + "issue_url": { "type": "string", "format": "uri" }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "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", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "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" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "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" - ] + "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", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "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.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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" + ] + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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-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 was unpinned.", + "operationId": "issue-comment/unpinned", + "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 unpinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unpinned" + ] + }, + "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", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "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.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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" + ] + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "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", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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-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.", + "description": "An issue was marked as blocked by another issue.", + "operationId": "issue-dependencies/blocked-by-added", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//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": { + "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": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "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", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "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" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "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" + ] }, "performed_via_github_app": { "title": "GitHub app", @@ -973460,13 +980745,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -976457,13 +983735,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -979646,13 +986917,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -982664,13 +989928,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -985833,13 +993090,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -988864,13 +996114,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -991932,13 +999175,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -994915,13 +1002151,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -997965,13 +1005194,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1000025,13 +1007247,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1003010,13 +1010225,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1006031,13 +1013239,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1008897,13 +1016098,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1010973,13 +1018167,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1013965,13 +1021152,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1017115,13 +1024295,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1020107,13 +1027280,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1023173,13 +1030339,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1026124,13 +1033283,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1029115,13 +1036267,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -1318948,7 +1326093,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1318995,7 +1326140,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1319042,7 +1326187,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1319089,7 +1326234,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1319136,7 +1326281,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1321874,7 +1329019,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1321921,7 +1329066,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1321968,7 +1329113,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1322015,7 +1329160,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1322062,7 +1329207,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324800,7 +1331945,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324847,7 +1331992,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324894,7 +1332039,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324941,7 +1332086,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1324988,7 +1332133,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1325874,7 +1333019,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1325921,7 +1333066,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1325968,7 +1333113,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326015,7 +1333160,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326062,7 +1333207,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326776,7 +1333921,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326823,7 +1333968,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326870,7 +1334015,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326917,7 +1334062,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1326964,7 +1334109,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327681,7 +1334826,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327728,7 +1334873,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327775,7 +1334920,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327822,7 +1334967,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -1327869,7 +1335014,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/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 239367d8b..6af52fa91 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -2530,13 +2530,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 @@ -20274,7 +20267,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 pattern @@ -20310,7 +20304,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 pattern @@ -20346,7 +20341,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 pattern @@ -20382,7 +20378,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 pattern @@ -20418,7 +20415,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 pattern @@ -20672,7 +20670,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -20685,7 +20683,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '201': description: Response @@ -20925,7 +20923,7 @@ paths: value: id: 21 name: super cool ruleset - target: repository + target: branch source_type: Enterprise source: my-enterprise enforcement: active @@ -20937,7 +20935,7 @@ paths: include: - "~ALL" rules: - - type: repository_delete + - type: deletion node_id: RRS_lACkVXNlcgQB _links: self: @@ -21040,7 +21038,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -21053,7 +21051,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '200': description: Response @@ -21153,7 +21151,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 @@ -21213,11 +21211,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 @@ -39616,6 +39614,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: *118 code_scanning_default_setup: type: string @@ -39973,6 +39980,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 @@ -41808,7 +41823,7 @@ paths: cli: type: string description: The organization policy for allowing or disallowing - Copilot in the CLI. + Copilot CLI. enum: - enabled - disabled @@ -45790,7 +45805,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' @@ -56854,11 +56868,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 @@ -102884,11 +102898,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 @@ -123926,7 +123940,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -123977,7 +123990,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -124323,7 +124335,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -124374,7 +124385,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -124720,7 +124730,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -124771,7 +124780,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -125132,7 +125140,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -125183,7 +125190,6 @@ x-webhooks: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -125747,11 +125753,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -126446,11 +126447,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -127138,11 +127134,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131721,11 +131712,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135530,492 +135516,482 @@ x-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 - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - 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 - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 @@ -142370,11 +142346,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -142831,7 +142802,2625 @@ x-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/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. + + 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/enterprise-cloud@latest//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/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: &884 + 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: *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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + enterprise: *853 + installation: *854 + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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: *791 + issue_dependencies_summary: *792 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *371 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: *855 + repository: *856 + 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/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. + + 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/enterprise-cloud@latest//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/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: &913 + 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: *884 + enterprise: *853 + installation: *854 + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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: *791 + issue_dependencies_summary: *792 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: *371 + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: *855 + repository: *856 + 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/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. @@ -142839,8 +145428,8 @@ x-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/enterprise-cloud@latest//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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -142884,178 +145473,14 @@ x-webhooks: content: application/json: schema: - title: issue_comment deleted event + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted - comment: &884 - 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: *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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: *884 enterprise: *853 installation: *854 issue: @@ -144220,7 +146645,7 @@ x-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/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. @@ -144228,8 +146653,8 @@ x-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/enterprise-cloud@latest//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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: @@ -144273,25 +146698,13 @@ x-webhooks: content: application/json: schema: - title: issue_comment edited event + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: &913 - 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: *884 enterprise: *853 installation: *854 @@ -144745,8 +147158,6 @@ x-webhooks: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: string nullable: true @@ -144926,7 +147337,6 @@ x-webhooks: enum: - read - write - - admin organization_secrets: type: string enum: @@ -145432,6 +147842,8 @@ x-webhooks: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -145442,7 +147854,6 @@ x-webhooks: sender: *4 required: - action - - changes - issue - comment - repository @@ -146584,11 +148995,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -147581,11 +149987,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -148703,11 +151104,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -149721,11 +152117,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -150838,11 +153229,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -151830,11 +154216,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -152856,11 +155237,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -153841,11 +156217,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -154799,11 +157170,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -156155,11 +158521,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -157141,11 +159502,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -158162,11 +160518,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -159118,11 +161469,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -160935,11 +163281,6 @@ x-webhooks: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 873f9e32f..78d6afb00 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -11374,7 +11374,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -11395,7 +11395,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -11564,7 +11564,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -11585,7 +11585,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -25860,6 +25860,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" }, @@ -26342,6 +26352,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", @@ -99314,13 +99333,13 @@ } } }, - "issue-dependencies-blocked-by-added": { + "issue-comment-pinned": { "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.", - "description": "An issue was marked as blocked by another issue.", - "operationId": "issue-dependencies/blocked-by-added", + "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 was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -99385,7 +99404,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" } } } @@ -99398,7 +99417,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -99407,11 +99426,104 @@ } } }, - "issue-dependencies-blocked-by-removed": { + "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 was unpinned.", + "operationId": "issue-comment/unpinned", + "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": { + "$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.", - "description": "The blocked by relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocked-by-removed", + "description": "An issue was marked as blocked by another issue.", + "operationId": "issue-dependencies/blocked-by-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, @@ -99478,7 +99590,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" } } } @@ -99500,11 +99612,11 @@ } } }, - "issue-dependencies-blocking-added": { + "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.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "An issue was marked as blocking another issue.", - "operationId": "issue-dependencies/blocking-added", + "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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, @@ -99571,7 +99683,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" } } } @@ -99593,11 +99705,11 @@ } } }, - "issue-dependencies-blocking-removed": { + "issue-dependencies-blocking-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.", - "description": "The blocking relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocking-removed", + "description": "An issue was marked as blocking another issue.", + "operationId": "issue-dependencies/blocking-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, @@ -99664,7 +99776,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" } } } @@ -99686,13 +99798,13 @@ } } }, - "issues-assigned": { + "issue-dependencies-blocking-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "summary": "This event occurs when there is activity relating to 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.", + "description": "The blocking relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocking-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -99757,7 +99869,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" } } } @@ -99770,7 +99882,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -99779,11 +99891,11 @@ } } }, - "issues-closed": { + "issues-assigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99850,7 +99962,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -99872,11 +99984,11 @@ } } }, - "issues-deleted": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99943,7 +100055,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -99965,11 +100077,11 @@ } } }, - "issues-demilestoned": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100036,7 +100148,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -100058,11 +100170,11 @@ } } }, - "issues-edited": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100129,7 +100241,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -100151,11 +100263,11 @@ } } }, - "issues-labeled": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100222,7 +100334,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -100244,11 +100356,11 @@ } } }, - "issues-locked": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100315,7 +100427,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -100337,11 +100449,11 @@ } } }, - "issues-milestoned": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100408,7 +100520,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -100430,11 +100542,11 @@ } } }, - "issues-opened": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100501,7 +100613,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -100523,11 +100635,11 @@ } } }, - "issues-pinned": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100594,7 +100706,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -100616,11 +100728,11 @@ } } }, - "issues-reopened": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100687,7 +100799,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -100709,11 +100821,11 @@ } } }, - "issues-transferred": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100780,7 +100892,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -100802,11 +100914,11 @@ } } }, - "issues-typed": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was added to an issue.", - "operationId": "issues/typed", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100873,7 +100985,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -100895,11 +101007,11 @@ } } }, - "issues-unassigned": { + "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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100966,7 +101078,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-typed" + } + } + } + }, + "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-unassigned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + }, + "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-unassigned" } } } @@ -118852,14 +119057,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.", @@ -126605,7 +126802,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -126652,7 +126849,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -126699,7 +126896,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -126746,7 +126943,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -126793,7 +126990,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -134647,7 +134844,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", @@ -162126,13 +162323,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -163512,13 +163702,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -172940,13 +173123,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -173763,13 +173939,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -174579,13 +174748,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178596,13 +178758,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183209,13 +183364,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183848,13 +183996,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -188311,13 +188452,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -189882,13 +190016,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -191462,13 +191589,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -192096,244 +192216,18 @@ "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", + "webhook-issue-comment-pinned": { + "title": "issue_comment pinned 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" @@ -192342,7 +192236,7 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", @@ -192912,10 +192806,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -193162,8 +193053,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -193394,12 +193284,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", @@ -193562,8 +193446,100 @@ "nullable": true }, "assignee": { + "title": "User", "type": "object", - "nullable": true + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", @@ -193604,8 +193580,45 @@ "labels": { "type": "array", "items": { + "title": "Label", "type": "object", - "nullable": true + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "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": { @@ -193667,10 +193680,11 @@ "type": "string" }, "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ - "closed", - "open" + "open", + "closed" ] }, "timeline_url": { @@ -193750,8 +193764,10 @@ } }, "required": [ + "labels", "state", - "closed_at" + "locked", + "assignee" ] } ] @@ -193769,20 +193785,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" }, @@ -193790,335 +193810,3576 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "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", - "nullable": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", + "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", - "nullable": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "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": { + "active_lock_reason": { "type": "string", + "nullable": true, "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "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", - "nullable": true - }, - "closed_at": { - "type": "string", - "nullable": true, - "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", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "closed_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "type": "object", + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": "object", "nullable": true, @@ -194703,13 +197964,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -195971,13 +199225,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -197210,13 +200457,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -198453,13 +201693,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -199733,13 +202966,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -200966,13 +204192,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -202169,13 +205388,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -203974,13 +207186,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -205281,13 +208486,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -206480,13 +209678,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -208496,13 +211687,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -304868,7 +308052,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -304886,7 +308070,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -304910,7 +308094,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -304931,41 +308115,39 @@ ] }, "enterprise-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": "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" + } + ] } - ] + } }, "organization-secret-scanning-alert-list": { "value": [ @@ -309671,7 +312853,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", @@ -313184,61 +316365,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" } - ] - } + } + ] } - ] + } }, "list-repository-advisories": { "value": [ @@ -326910,51 +330089,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": [ @@ -332534,7 +335711,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -332589,7 +335765,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -332860,7 +336035,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -332915,7 +336089,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -333173,7 +336346,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -333228,7 +336400,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -333514,7 +336685,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] @@ -333569,7 +336739,6 @@ "repository_hooks": "write", "repository_projects": "write", "statuses": "write", - "team_discussions": "write", "vulnerability_alerts": "read" }, "events": [] diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 17e46583d..0347fee4a 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -8195,7 +8195,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -8208,7 +8208,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '201': description: Response @@ -8323,7 +8323,7 @@ paths: default: value: name: super cool ruleset - target: repository + target: branch enforcement: active bypass_actors: - actor_id: 234 @@ -8336,7 +8336,7 @@ paths: exclude: - unimportant_org rules: - - type: repository_delete + - type: deletion responses: '200': description: Response @@ -18627,6 +18627,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: @@ -19003,6 +19012,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 @@ -71690,284 +71707,18 @@ x-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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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: + issue-comment-pinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + 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. - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -72009,7 +71760,7 @@ x-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 @@ -72017,23 +71768,23 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + 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. - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -72075,7 +71826,7 @@ x-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 @@ -72083,23 +71834,23 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -72141,7 +71892,7 @@ x-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 @@ -72149,23 +71900,24 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -72207,7 +71959,7 @@ x-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 @@ -72215,12 +71967,145 @@ x-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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72228,8 +72113,8 @@ x-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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72273,7 +72158,7 @@ x-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 @@ -72286,7 +72171,7 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72294,8 +72179,8 @@ x-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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72339,7 +72224,7 @@ x-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 @@ -72352,7 +72237,7 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72360,9 +72245,8 @@ x-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/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72406,7 +72290,7 @@ x-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 @@ -72419,7 +72303,7 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72427,8 +72311,8 @@ x-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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72472,7 +72356,7 @@ x-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 @@ -72485,7 +72369,7 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72493,9 +72377,8 @@ x-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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72539,7 +72422,7 @@ x-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 @@ -72552,7 +72435,7 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72560,9 +72443,8 @@ x-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/enterprise-cloud@latest//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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72606,7 +72488,7 @@ x-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 @@ -72619,7 +72501,7 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72627,8 +72509,9 @@ x-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/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72672,7 +72555,7 @@ x-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 @@ -72685,7 +72568,7 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72693,9 +72576,8 @@ x-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/enterprise-cloud@latest//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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -72739,7 +72621,7 @@ x-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 @@ -72752,7 +72634,7 @@ x-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. @@ -72760,8 +72642,275 @@ x-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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + + 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + + 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-issues-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + + 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues + 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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. + + 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: @@ -85738,13 +85887,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 @@ -91982,7 +92124,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. @@ -92016,7 +92158,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. @@ -92050,7 +92192,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. @@ -92084,7 +92226,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. @@ -92118,7 +92260,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. @@ -98215,7 +98357,7 @@ components: cli: type: string description: The organization policy for allowing or disallowing Copilot - in the CLI. + CLI. enum: - enabled - disabled @@ -119297,11 +119439,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -120342,11 +120479,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -127512,11 +127644,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -128141,11 +128268,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -128763,11 +128885,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -131825,11 +131942,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135102,11 +135214,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -135585,11 +135692,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -138803,11 +138905,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -139971,11 +140068,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -141146,11 +141238,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -141602,182 +141689,23 @@ components: - 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 + webhook-issue-comment-pinned: + title: issue_comment pinned 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/enterprise-cloud@latest//rest/issues/issues#get-an-issue) - itself. + the comment belongs to. allOf: - title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -142225,9 +142153,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - reminder - - pull_request_review_thread external_url: type: string nullable: true @@ -142407,7 +142332,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -142572,10 +142496,6 @@ 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 @@ -142699,8 +142619,75 @@ components: type: string nullable: true assignee: + title: User type: object nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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: @@ -142729,8 +142716,37 @@ components: labels: type: array items: + title: Label type: object - nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + 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: @@ -142771,10 +142787,11 @@ components: repository_url: type: string state: + description: State of the issue; either 'open' or 'closed' type: string enum: - - closed - open + - closed timeline_url: type: string title: @@ -142826,8 +142843,10 @@ components: user_view_type: type: string required: + - labels - state - - closed_at + - locked + - assignee organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -142837,107 +142856,42 @@ components: 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" installation: "$ref": "#/components/schemas/simple-installation" issue: - 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 - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: title: User type: object nullable: true @@ -142998,6 +142952,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -143006,101 +142961,9 @@ components: 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 - nullable: true - closed_at: - type: string - nullable: true - 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 - nullable: true - 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 - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: + assignees: + type: array + items: title: User type: object nullable: true @@ -143161,6 +143024,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -143169,595 +143033,990 @@ components: required: - login - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - 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 - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - 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 - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User + 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 + nullable: true + closed_at: + type: string + nullable: true + 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 - nullable: true properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - 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: + description: URL for the label 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: + - 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: type: string enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - 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 - nullable: true - 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 - nullable: true - 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 - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 + - 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: @@ -143767,16 +144026,1249 @@ components: required: - action - issue + - comment - repository - sender - webhook-issues-demilestoned: - title: issues demilestoned event + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event type: object properties: action: type: string enum: - - demilestoned + - 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/enterprise-cloud@latest//rest/issues/issues#get-an-issue) + itself. + 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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + assignee: + type: object + nullable: true + assignees: + type: array + items: + type: object + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + 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 + nullable: true + labels_url: + type: string + locked: + type: boolean + milestone: + type: object + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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: @@ -143786,28 +145278,6 @@ components: description: The [issue](https://docs.github.com/enterprise-cloud@latest//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 @@ -143822,9 +145292,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -143882,19 +145349,20 @@ components: - 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 nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -143952,10 +145420,14 @@ 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. @@ -144001,15 +145473,6 @@ components: items: title: Label type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -144031,6 +145494,14 @@ 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 @@ -144041,23 +145512,6 @@ components: description: A collection of related issues and pull requests. type: object nullable: true - 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 @@ -144072,9 +145526,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -144132,12 +145583,14 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: string nullable: true @@ -144175,6 +145628,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: @@ -144187,16 +145657,6 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: string @@ -144256,6 +145716,7 @@ components: - watch - workflow_dispatch - workflow_run + - reminder external_url: type: string nullable: true @@ -144276,9 +145737,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -144341,6 +145799,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -144435,7 +145896,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -144506,11 +145966,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -144528,6 +145983,16 @@ components: type: string nullable: true format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -144550,17 +146015,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -144583,6 +146037,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 @@ -144622,9 +146087,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -144683,134 +146145,6 @@ components: - Bot - User - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - milestone: - "$ref": "#/components/schemas/webhooks_milestone" - 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-edited: - title: issues edited 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 - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - 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 - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: 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 @@ -144819,12 +146153,165 @@ components: 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/enterprise-cloud@latest//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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -144886,9 +146373,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -144934,6 +146418,15 @@ components: items: title: Label type: object + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -144955,14 +146448,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 @@ -144973,6 +146458,23 @@ components: description: A collection of related issues and pull requests. type: object nullable: true + 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 @@ -144987,6 +146489,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -145050,9 +146555,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id description: type: string nullable: true @@ -145090,23 +146592,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: @@ -145119,6 +146604,16 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: string @@ -145178,9 +146673,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - - reminder external_url: type: string nullable: true @@ -145201,6 +146693,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -145263,9 +146758,6 @@ components: format: uri user_view_type: type: string - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -145431,11 +146923,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -145453,16 +146940,6 @@ components: type: string nullable: true format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -145485,6 +146962,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -145507,17 +146995,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 @@ -145541,11 +147018,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 @@ -145557,6 +147034,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -145621,33 +147101,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: @@ -145656,18 +147111,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: @@ -146116,6 +147590,7 @@ components: - watch - workflow_dispatch - workflow_run + - security_and_analysis - pull_request_review_thread - reminder external_url: @@ -146368,11 +147843,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -146593,17 +148063,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: @@ -146613,29 +148084,6 @@ components: description: The [issue](https://docs.github.com/enterprise-cloud@latest//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: string @@ -146650,9 +148098,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -146710,20 +148155,21 @@ components: - 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 nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -146781,11 +148227,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. @@ -146831,15 +148279,6 @@ components: items: title: Label type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -146861,35 +148300,24 @@ 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 nullable: true - 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 @@ -146904,9 +148332,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -146964,11 +148389,15 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri user_view_type: type: string + required: + - login + - id description: type: string nullable: true @@ -147006,6 +148435,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: @@ -147018,16 +148464,6 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at properties: created_at: type: string @@ -147087,8 +148523,8 @@ components: - watch - workflow_dispatch - workflow_run + - pull_request_review_thread - reminder - - security_and_analysis external_url: type: string nullable: true @@ -147109,9 +148545,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -147174,6 +148607,9 @@ components: format: uri user_view_type: type: string + required: + - login + - id permissions: description: The set of permissions for the GitHub app type: object @@ -147268,6 +148704,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -147338,11 +148775,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -147360,6 +148792,16 @@ components: type: string nullable: true format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at pull_request: type: object properties: @@ -147382,17 +148824,6 @@ components: reactions: title: Reactions type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket properties: "+1": type: integer @@ -147415,6 +148846,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 @@ -147454,9 +148896,6 @@ components: title: User type: object nullable: true - required: - - login - - id properties: avatar_url: type: string @@ -147515,11 +148954,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: @@ -147531,14 +148998,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: @@ -147561,6 +149028,7 @@ components: - html_url - id - labels_url + - locked - milestone - node_id - number @@ -147647,6 +149115,8 @@ components: url: type: string format: uri + user_view_type: + type: string assignees: type: array items: @@ -147716,6 +149186,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. @@ -147796,6 +149268,8 @@ components: format: uri-template locked: type: boolean + enum: + - true milestone: title: Milestone description: A collection of related issues and pull requests. @@ -147892,7 +149366,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -148017,6 +149490,7 @@ components: - workflow_dispatch - workflow_run - reminder + - security_and_analysis external_url: type: string nullable: true @@ -148196,7 +149670,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -148267,7 +149740,926 @@ 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 + nullable: true + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-cloud@latest//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 + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + closed_at: + type: string + nullable: true + 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 + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + 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 + nullable: true + 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 + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + nullable: true + due_on: + type: string + nullable: true + 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 + nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + 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 + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 @@ -149168,11 +151560,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -150529,11 +152916,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -151519,11 +153901,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -152417,11 +154794,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -153940,11 +156312,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -227450,7 +229817,7 @@ components: value: id: 21 name: super cool ruleset - target: repository + target: branch source_type: Enterprise source: my-enterprise enforcement: active @@ -227462,7 +229829,7 @@ components: include: - "~ALL" rules: - - type: repository_delete + - type: deletion node_id: RRS_lACkVXNlcgQB _links: self: @@ -227477,7 +229844,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 @@ -227490,11 +229857,11 @@ components: updated_at: '2024-08-23T16:29:47Z' enterprise-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 @@ -231495,7 +233862,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' @@ -234518,11 +236884,11 @@ components: rule_type: commit_message_pattern 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 @@ -246271,11 +248637,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 @@ -251061,7 +253427,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -251112,7 +253477,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -251356,7 +253720,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -251407,7 +253770,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -251639,7 +254001,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -251690,7 +254051,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -251947,7 +254307,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -251998,7 +254357,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 873f9e32f..78d6afb00 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -11374,7 +11374,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -11395,7 +11395,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -11564,7 +11564,7 @@ "default": { "value": { "name": "super cool ruleset", - "target": "repository", + "target": "branch", "enforcement": "active", "bypass_actors": [ { @@ -11585,7 +11585,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ] } @@ -25860,6 +25860,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" }, @@ -26342,6 +26352,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", @@ -99314,13 +99333,13 @@ } } }, - "issue-dependencies-blocked-by-added": { + "issue-comment-pinned": { "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.", - "description": "An issue was marked as blocked by another issue.", - "operationId": "issue-dependencies/blocked-by-added", + "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 was pinned.", + "operationId": "issue-comment/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -99385,7 +99404,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" } } } @@ -99398,7 +99417,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -99407,11 +99426,104 @@ } } }, - "issue-dependencies-blocked-by-removed": { + "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 was unpinned.", + "operationId": "issue-comment/unpinned", + "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": { + "$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.", - "description": "The blocked by relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocked-by-removed", + "description": "An issue was marked as blocked by another issue.", + "operationId": "issue-dependencies/blocked-by-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, @@ -99478,7 +99590,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" } } } @@ -99500,11 +99612,11 @@ } } }, - "issue-dependencies-blocking-added": { + "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.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "An issue was marked as blocking another issue.", - "operationId": "issue-dependencies/blocking-added", + "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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, @@ -99571,7 +99683,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" } } } @@ -99593,11 +99705,11 @@ } } }, - "issue-dependencies-blocking-removed": { + "issue-dependencies-blocking-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.", - "description": "The blocking relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocking-removed", + "description": "An issue was marked as blocking another issue.", + "operationId": "issue-dependencies/blocking-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, @@ -99664,7 +99776,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" } } } @@ -99686,13 +99798,13 @@ } } }, - "issues-assigned": { + "issue-dependencies-blocking-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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "summary": "This event occurs when there is activity relating to 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.", + "description": "The blocking relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocking-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -99757,7 +99869,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" } } } @@ -99770,7 +99882,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -99779,11 +99891,11 @@ } } }, - "issues-closed": { + "issues-assigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99850,7 +99962,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -99872,11 +99984,11 @@ } } }, - "issues-deleted": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -99943,7 +100055,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -99965,11 +100077,11 @@ } } }, - "issues-demilestoned": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100036,7 +100148,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -100058,11 +100170,11 @@ } } }, - "issues-edited": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100129,7 +100241,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -100151,11 +100263,11 @@ } } }, - "issues-labeled": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100222,7 +100334,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -100244,11 +100356,11 @@ } } }, - "issues-locked": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100315,7 +100427,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -100337,11 +100449,11 @@ } } }, - "issues-milestoned": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100408,7 +100520,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -100430,11 +100542,11 @@ } } }, - "issues-opened": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100501,7 +100613,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -100523,11 +100635,11 @@ } } }, - "issues-pinned": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100594,7 +100706,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -100616,11 +100728,11 @@ } } }, - "issues-reopened": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100687,7 +100799,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -100709,11 +100821,11 @@ } } }, - "issues-transferred": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100780,7 +100892,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -100802,11 +100914,11 @@ } } }, - "issues-typed": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was added to an issue.", - "operationId": "issues/typed", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100873,7 +100985,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -100895,11 +101007,11 @@ } } }, - "issues-unassigned": { + "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/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100966,7 +101078,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-typed" + } + } + } + }, + "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-unassigned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + }, + "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-unassigned" } } } @@ -118852,14 +119057,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.", @@ -126605,7 +126802,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -126652,7 +126849,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -126699,7 +126896,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -126746,7 +126943,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -126793,7 +126990,7 @@ "properties": { "name": { "type": "string", - "description": "How this rule will appear to users." + "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", @@ -134647,7 +134844,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", @@ -162126,13 +162323,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -163512,13 +163702,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -172940,13 +173123,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -173763,13 +173939,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -174579,13 +174748,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -178596,13 +178758,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183209,13 +183364,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -183848,13 +183996,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -188311,13 +188452,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -189882,13 +190016,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -191462,13 +191589,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -192096,244 +192216,18 @@ "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", + "webhook-issue-comment-pinned": { + "title": "issue_comment pinned 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" @@ -192342,7 +192236,7 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", @@ -192912,10 +192806,7 @@ "team_add", "watch", "workflow_dispatch", - "workflow_run", - "security_and_analysis", - "reminder", - "pull_request_review_thread" + "workflow_run" ] } }, @@ -193162,8 +193053,7 @@ "type": "string", "enum": [ "read", - "write", - "admin" + "write" ] }, "organization_secrets": { @@ -193394,12 +193284,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", @@ -193562,8 +193446,100 @@ "nullable": true }, "assignee": { + "title": "User", "type": "object", - "nullable": true + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", @@ -193604,8 +193580,45 @@ "labels": { "type": "array", "items": { + "title": "Label", "type": "object", - "nullable": true + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "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": { @@ -193667,10 +193680,11 @@ "type": "string" }, "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": [ - "closed", - "open" + "open", + "closed" ] }, "timeline_url": { @@ -193750,8 +193764,10 @@ } }, "required": [ + "labels", "state", - "closed_at" + "locked", + "assignee" ] } ] @@ -193769,20 +193785,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" }, @@ -193790,335 +193810,3576 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "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", - "nullable": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "title": "User", + "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", - "nullable": true, "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "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": { + "active_lock_reason": { "type": "string", + "nullable": true, "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "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", - "nullable": true - }, - "closed_at": { - "type": "string", - "nullable": true, - "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", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "closed_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "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", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "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", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "assignee": { + "type": "object", + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "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/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "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", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": "object", "nullable": true, @@ -194703,13 +197964,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -195971,13 +199225,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -197210,13 +200457,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -198453,13 +201693,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -199733,13 +202966,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -200966,13 +204192,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -202169,13 +205388,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -203974,13 +207186,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -205281,13 +208486,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -206480,13 +209678,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -208496,13 +211687,6 @@ "write" ] }, - "team_discussions": { - "type": "string", - "enum": [ - "read", - "write" - ] - }, "vulnerability_alerts": { "type": "string", "enum": [ @@ -304868,7 +308052,7 @@ "value": { "id": 21, "name": "super cool ruleset", - "target": "repository", + "target": "branch", "source_type": "Enterprise", "source": "my-enterprise", "enforcement": "active", @@ -304886,7 +308070,7 @@ }, "rules": [ { - "type": "repository_delete" + "type": "deletion" } ], "node_id": "RRS_lACkVXNlcgQB", @@ -304910,7 +308094,7 @@ "id": 1, "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" + "updated_at": "2024-10-23T16:29:47Z" }, { "version_id": 2, @@ -304931,41 +308115,39 @@ ] }, "enterprise-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": "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" + } + ] } - ] + } }, "organization-secret-scanning-alert-list": { "value": [ @@ -309671,7 +312853,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", @@ -313184,61 +316365,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" } - ] - } + } + ] } - ] + } }, "list-repository-advisories": { "value": [ @@ -326910,51 +330089,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*" - ] - } - }, - {"code":"deadline_exceeded","msg":"operation timed out"}